lib/flow.c

   1 /*
   2  * Copyright (c) 2008, 2009, 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 #include <config.h>
  17 #include <sys/types.h>
  18 #include "flow.h"
  19 #include <assert.h>
  20 #include <errno.h>
  21 #include <inttypes.h>
  22 #include <limits.h>
  23 #include <netinet/in.h>
  24 #include <netinet/icmp6.h>
  25 #include <netinet/ip6.h>
  26 #include <stdint.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include "byte-order.h"
  30 #include "coverage.h"
  31 #include "csum.h"
  32 #include "dynamic-string.h"
  33 #include "hash.h"
  34 #include "match.h"
  35 #include "ofpbuf.h"
  36 #include "openflow/openflow.h"
  37 #include "packets.h"
  38 #include "unaligned.h"
  39 #include "vlog.h"
  40
  41 VLOG_DEFINE_THIS_MODULE(flow);
  42
  43 COVERAGE_DEFINE(flow_extract);
  44 COVERAGE_DEFINE(miniflow_malloc);
  45
  46 static struct arp_eth_header *
  47 pull_arp(struct ofpbuf *packet)
  48 {
  49     return ofpbuf_try_pull(packet, ARP_ETH_HEADER_LEN);
  50 }
  51
  52 static struct ip_header *
  53 pull_ip(struct ofpbuf *packet)
  54 {
  55     if (packet->size >= IP_HEADER_LEN) {
  56         struct ip_header *ip = packet->data;
  57         int ip_len = IP_IHL(ip->ip_ihl_ver) * 4;
  58         if (ip_len >= IP_HEADER_LEN && packet->size >= ip_len) {
  59             return ofpbuf_pull(packet, ip_len);
  60         }
  61     }
  62     return NULL;
  63 }
  64
  65 static struct tcp_header *
  66 pull_tcp(struct ofpbuf *packet)
  67 {
  68     if (packet->size >= TCP_HEADER_LEN) {
  69         struct tcp_header *tcp = packet->data;
  70         int tcp_len = TCP_OFFSET(tcp->tcp_ctl) * 4;
  71         if (tcp_len >= TCP_HEADER_LEN && packet->size >= tcp_len) {
  72             return ofpbuf_pull(packet, tcp_len);
  73         }
  74     }
  75     return NULL;
  76 }
  77
  78 static struct udp_header *
  79 pull_udp(struct ofpbuf *packet)
  80 {
  81     return ofpbuf_try_pull(packet, UDP_HEADER_LEN);
  82 }
  83
  84 static struct icmp_header *
  85 pull_icmp(struct ofpbuf *packet)
  86 {
  87     return ofpbuf_try_pull(packet, ICMP_HEADER_LEN);
  88 }
  89
  90 static struct icmp6_hdr *
  91 pull_icmpv6(struct ofpbuf *packet)
  92 {
  93     return ofpbuf_try_pull(packet, sizeof(struct icmp6_hdr));
  94 }
  95
  96 static void
  97 parse_vlan(struct ofpbuf *b, struct flow *flow)
  98 {
  99     struct qtag_prefix {
 100         ovs_be16 eth_type;      /* ETH_TYPE_VLAN */
 101         ovs_be16 tci;
 102     };
 103
 104     if (b->size >= sizeof(struct qtag_prefix) + sizeof(ovs_be16)) {
 105         struct qtag_prefix *qp = ofpbuf_pull(b, sizeof *qp);
 106         flow->vlan_tci = qp->tci | htons(VLAN_CFI);
 107     }
 108 }
 109
 110 static ovs_be16
 111 parse_ethertype(struct ofpbuf *b)
 112 {
 113     struct llc_snap_header *llc;
 114     ovs_be16 proto;
 115
 116     proto = *(ovs_be16 *) ofpbuf_pull(b, sizeof proto);
 117     if (ntohs(proto) >= ETH_TYPE_MIN) {
 118         return proto;
 119     }
 120
 121     if (b->size < sizeof *llc) {
 122         return htons(FLOW_DL_TYPE_NONE);
 123     }
 124
 125     llc = b->data;
 126     if (llc->llc.llc_dsap != LLC_DSAP_SNAP
 127         || llc->llc.llc_ssap != LLC_SSAP_SNAP
 128         || llc->llc.llc_cntl != LLC_CNTL_SNAP
 129         || memcmp(llc->snap.snap_org, SNAP_ORG_ETHERNET,
 130                   sizeof llc->snap.snap_org)) {
 131         return htons(FLOW_DL_TYPE_NONE);
 132     }
 133
 134     ofpbuf_pull(b, sizeof *llc);
 135     return llc->snap.snap_type;
 136 }
 137
 138 static int
 139 parse_ipv6(struct ofpbuf *packet, struct flow *flow)
 140 {
 141     const struct ip6_hdr *nh;
 142     ovs_be32 tc_flow;
 143     int nexthdr;
 144
 145     nh = ofpbuf_try_pull(packet, sizeof *nh);
 146     if (!nh) {
 147         return EINVAL;
 148     }
 149
 150     nexthdr = nh->ip6_nxt;
 151
 152     flow->ipv6_src = nh->ip6_src;
 153     flow->ipv6_dst = nh->ip6_dst;
 154
 155     tc_flow = get_unaligned_be32(&nh->ip6_flow);
 156     flow->nw_tos = ntohl(tc_flow) >> 20;
 157     flow->ipv6_label = tc_flow & htonl(IPV6_LABEL_MASK);
 158     flow->nw_ttl = nh->ip6_hlim;
 159     flow->nw_proto = IPPROTO_NONE;
 160
 161     while (1) {
 162         if ((nexthdr != IPPROTO_HOPOPTS)
 163                 && (nexthdr != IPPROTO_ROUTING)
 164                 && (nexthdr != IPPROTO_DSTOPTS)
 165                 && (nexthdr != IPPROTO_AH)
 166                 && (nexthdr != IPPROTO_FRAGMENT)) {
 167             /* It's either a terminal header (e.g., TCP, UDP) or one we
 168              * don't understand.  In either case, we're done with the
 169              * packet, so use it to fill in 'nw_proto'. */
 170             break;
 171         }
 172
 173         /* We only verify that at least 8 bytes of the next header are
 174          * available, but many of these headers are longer.  Ensure that
 175          * accesses within the extension header are within those first 8
 176          * bytes. All extension headers are required to be at least 8
 177          * bytes. */
 178         if (packet->size < 8) {
 179             return EINVAL;
 180         }
 181
 182         if ((nexthdr == IPPROTO_HOPOPTS)
 183                 || (nexthdr == IPPROTO_ROUTING)
 184                 || (nexthdr == IPPROTO_DSTOPTS)) {
 185             /* These headers, while different, have the fields we care about
 186              * in the same location and with the same interpretation. */
 187             const struct ip6_ext *ext_hdr = packet->data;
 188             nexthdr = ext_hdr->ip6e_nxt;
 189             if (!ofpbuf_try_pull(packet, (ext_hdr->ip6e_len + 1) * 8)) {
 190                 return EINVAL;
 191             }
 192         } else if (nexthdr == IPPROTO_AH) {
 193             /* A standard AH definition isn't available, but the fields
 194              * we care about are in the same location as the generic
 195              * option header--only the header length is calculated
 196              * differently. */
 197             const struct ip6_ext *ext_hdr = packet->data;
 198             nexthdr = ext_hdr->ip6e_nxt;
 199             if (!ofpbuf_try_pull(packet, (ext_hdr->ip6e_len + 2) * 4)) {
 200                return EINVAL;
 201             }
 202         } else if (nexthdr == IPPROTO_FRAGMENT) {
 203             const struct ip6_frag *frag_hdr = packet->data;
 204
 205             nexthdr = frag_hdr->ip6f_nxt;
 206             if (!ofpbuf_try_pull(packet, sizeof *frag_hdr)) {
 207                 return EINVAL;
 208             }
 209
 210             /* We only process the first fragment. */
 211             if (frag_hdr->ip6f_offlg != htons(0)) {
 212                 if ((frag_hdr->ip6f_offlg & IP6F_OFF_MASK) == htons(0)) {
 213                     flow->nw_frag = FLOW_NW_FRAG_ANY;
 214                 } else {
 215                     flow->nw_frag |= FLOW_NW_FRAG_LATER;
 216                     nexthdr = IPPROTO_FRAGMENT;
 217                     break;
 218                 }
 219             }
 220         }
 221     }
 222
 223     flow->nw_proto = nexthdr;
 224     return 0;
 225 }
 226
 227 static void
 228 parse_tcp(struct ofpbuf *packet, struct ofpbuf *b, struct flow *flow)
 229 {
 230     const struct tcp_header *tcp = pull_tcp(b);
 231     if (tcp) {
 232         flow->tp_src = tcp->tcp_src;
 233         flow->tp_dst = tcp->tcp_dst;
 234         packet->l7 = b->data;
 235     }
 236 }
 237
 238 static void
 239 parse_udp(struct ofpbuf *packet, struct ofpbuf *b, struct flow *flow)
 240 {
 241     const struct udp_header *udp = pull_udp(b);
 242     if (udp) {
 243         flow->tp_src = udp->udp_src;
 244         flow->tp_dst = udp->udp_dst;
 245         packet->l7 = b->data;
 246     }
 247 }
 248
 249 static bool
 250 parse_icmpv6(struct ofpbuf *b, struct flow *flow)
 251 {
 252     const struct icmp6_hdr *icmp = pull_icmpv6(b);
 253
 254     if (!icmp) {
 255         return false;
 256     }
 257
 258     /* The ICMPv6 type and code fields use the 16-bit transport port
 259      * fields, so we need to store them in 16-bit network byte order. */
 260     flow->tp_src = htons(icmp->icmp6_type);
 261     flow->tp_dst = htons(icmp->icmp6_code);
 262
 263     if (icmp->icmp6_code == 0 &&
 264         (icmp->icmp6_type == ND_NEIGHBOR_SOLICIT ||
 265          icmp->icmp6_type == ND_NEIGHBOR_ADVERT)) {
 266         const struct in6_addr *nd_target;
 267
 268         nd_target = ofpbuf_try_pull(b, sizeof *nd_target);
 269         if (!nd_target) {
 270             return false;
 271         }
 272         flow->nd_target = *nd_target;
 273
 274         while (b->size >= 8) {
 275             /* The minimum size of an option is 8 bytes, which also is
 276              * the size of Ethernet link-layer options. */
 277             const struct nd_opt_hdr *nd_opt = b->data;
 278             int opt_len = nd_opt->nd_opt_len * 8;
 279
 280             if (!opt_len || opt_len > b->size) {
 281                 goto invalid;
 282             }
 283
 284             /* Store the link layer address if the appropriate option is
 285              * provided.  It is considered an error if the same link
 286              * layer option is specified twice. */
 287             if (nd_opt->nd_opt_type == ND_OPT_SOURCE_LINKADDR
 288                     && opt_len == 8) {
 289                 if (eth_addr_is_zero(flow->arp_sha)) {
 290                     memcpy(flow->arp_sha, nd_opt + 1, ETH_ADDR_LEN);
 291                 } else {
 292                     goto invalid;
 293                 }
 294             } else if (nd_opt->nd_opt_type == ND_OPT_TARGET_LINKADDR
 295                     && opt_len == 8) {
 296                 if (eth_addr_is_zero(flow->arp_tha)) {
 297                     memcpy(flow->arp_tha, nd_opt + 1, ETH_ADDR_LEN);
 298                 } else {
 299                     goto invalid;
 300                 }
 301             }
 302
 303             if (!ofpbuf_try_pull(b, opt_len)) {
 304                 goto invalid;
 305             }
 306         }
 307     }
 308
 309     return true;
 310
 311 invalid:
 312     memset(&flow->nd_target, 0, sizeof(flow->nd_target));
 313     memset(flow->arp_sha, 0, sizeof(flow->arp_sha));
 314     memset(flow->arp_tha, 0, sizeof(flow->arp_tha));
 315
 316     return false;
 317
 318 }
 319
 320 /* Initializes 'flow' members from 'packet', 'skb_priority', 'tnl', and
 321  * 'ofp_in_port'.
 322  *
 323  * Initializes 'packet' header pointers as follows:
 324  *
 325  *    - packet->l2 to the start of the Ethernet header.
 326  *
 327  *    - packet->l3 to just past the Ethernet header, or just past the
 328  *      vlan_header if one is present, to the first byte of the payload of the
 329  *      Ethernet frame.
 330  *
 331  *    - packet->l4 to just past the IPv4 header, if one is present and has a
 332  *      correct length, and otherwise NULL.
 333  *
 334  *    - packet->l7 to just past the TCP or UDP or ICMP header, if one is
 335  *      present and has a correct length, and otherwise NULL.
 336  */
 337 void
 338 flow_extract(struct ofpbuf *packet, uint32_t skb_priority,
 339              const struct flow_tnl *tnl, uint16_t ofp_in_port,
 340              struct flow *flow)
 341 {
 342     struct ofpbuf b = *packet;
 343     struct eth_header *eth;
 344
 345     COVERAGE_INC(flow_extract);
 346
 347     memset(flow, 0, sizeof *flow);
 348
 349     if (tnl) {
 350         assert(tnl != &flow->tunnel);
 351         flow->tunnel = *tnl;
 352     }
 353     flow->in_port = ofp_in_port;
 354     flow->skb_priority = skb_priority;
 355
 356     packet->l2 = b.data;
 357     packet->l3 = NULL;
 358     packet->l4 = NULL;
 359     packet->l7 = NULL;
 360
 361     if (b.size < sizeof *eth) {
 362         return;
 363     }
 364
 365     /* Link layer. */
 366     eth = b.data;
 367     memcpy(flow->dl_src, eth->eth_src, ETH_ADDR_LEN);
 368     memcpy(flow->dl_dst, eth->eth_dst, ETH_ADDR_LEN);
 369
 370     /* dl_type, vlan_tci. */
 371     ofpbuf_pull(&b, ETH_ADDR_LEN * 2);
 372     if (eth->eth_type == htons(ETH_TYPE_VLAN)) {
 373         parse_vlan(&b, flow);
 374     }
 375     flow->dl_type = parse_ethertype(&b);
 376
 377     /* Network layer. */
 378     packet->l3 = b.data;
 379     if (flow->dl_type == htons(ETH_TYPE_IP)) {
 380         const struct ip_header *nh = pull_ip(&b);
 381         if (nh) {
 382             packet->l4 = b.data;
 383
 384             flow->nw_src = get_unaligned_be32(&nh->ip_src);
 385             flow->nw_dst = get_unaligned_be32(&nh->ip_dst);
 386             flow->nw_proto = nh->ip_proto;
 387
 388             flow->nw_tos = nh->ip_tos;
 389             if (IP_IS_FRAGMENT(nh->ip_frag_off)) {
 390                 flow->nw_frag = FLOW_NW_FRAG_ANY;
 391                 if (nh->ip_frag_off & htons(IP_FRAG_OFF_MASK)) {
 392                     flow->nw_frag |= FLOW_NW_FRAG_LATER;
 393                 }
 394             }
 395             flow->nw_ttl = nh->ip_ttl;
 396
 397             if (!(nh->ip_frag_off & htons(IP_FRAG_OFF_MASK))) {
 398                 if (flow->nw_proto == IPPROTO_TCP) {
 399                     parse_tcp(packet, &b, flow);
 400                 } else if (flow->nw_proto == IPPROTO_UDP) {
 401                     parse_udp(packet, &b, flow);
 402                 } else if (flow->nw_proto == IPPROTO_ICMP) {
 403                     const struct icmp_header *icmp = pull_icmp(&b);
 404                     if (icmp) {
 405                         flow->tp_src = htons(icmp->icmp_type);
 406                         flow->tp_dst = htons(icmp->icmp_code);
 407                         packet->l7 = b.data;
 408                     }
 409                 }
 410             }
 411         }
 412     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
 413         if (parse_ipv6(&b, flow)) {
 414             return;
 415         }
 416
 417         packet->l4 = b.data;
 418         if (flow->nw_proto == IPPROTO_TCP) {
 419             parse_tcp(packet, &b, flow);
 420         } else if (flow->nw_proto == IPPROTO_UDP) {
 421             parse_udp(packet, &b, flow);
 422         } else if (flow->nw_proto == IPPROTO_ICMPV6) {
 423             if (parse_icmpv6(&b, flow)) {
 424                 packet->l7 = b.data;
 425             }
 426         }
 427     } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
 428         const struct arp_eth_header *arp = pull_arp(&b);
 429         if (arp && arp->ar_hrd == htons(1)
 430             && arp->ar_pro == htons(ETH_TYPE_IP)
 431             && arp->ar_hln == ETH_ADDR_LEN
 432             && arp->ar_pln == 4) {
 433             /* We only match on the lower 8 bits of the opcode. */
 434             if (ntohs(arp->ar_op) <= 0xff) {
 435                 flow->nw_proto = ntohs(arp->ar_op);
 436             }
 437
 438             if ((flow->nw_proto == ARP_OP_REQUEST)
 439                 || (flow->nw_proto == ARP_OP_REPLY)) {
 440                 flow->nw_src = arp->ar_spa;
 441                 flow->nw_dst = arp->ar_tpa;
 442                 memcpy(flow->arp_sha, arp->ar_sha, ETH_ADDR_LEN);
 443                 memcpy(flow->arp_tha, arp->ar_tha, ETH_ADDR_LEN);
 444             }
 445         }
 446     }
 447 }
 448
 449 /* For every bit of a field that is wildcarded in 'wildcards', sets the
 450  * corresponding bit in 'flow' to zero. */
 451 void
 452 flow_zero_wildcards(struct flow *flow, const struct flow_wildcards *wildcards)
 453 {
 454     uint32_t *flow_u32 = (uint32_t *) flow;
 455     const uint32_t *wc_u32 = (const uint32_t *) &wildcards->masks;
 456     size_t i;
 457
 458     for (i = 0; i < FLOW_U32S; i++) {
 459         flow_u32[i] &= wc_u32[i];
 460     }
 461 }
 462
 463 /* Initializes 'fmd' with the metadata found in 'flow'. */
 464 void
 465 flow_get_metadata(const struct flow *flow, struct flow_metadata *fmd)
 466 {
 467     BUILD_ASSERT_DECL(FLOW_WC_SEQ == 17);
 468
 469     fmd->tun_id = flow->tunnel.tun_id;
 470     fmd->metadata = flow->metadata;
 471     memcpy(fmd->regs, flow->regs, sizeof fmd->regs);
 472     fmd->in_port = flow->in_port;
 473 }
 474
 475 char *
 476 flow_to_string(const struct flow *flow)
 477 {
 478     struct ds ds = DS_EMPTY_INITIALIZER;
 479     flow_format(&ds, flow);
 480     return ds_cstr(&ds);
 481 }
 482
 483 void
 484 flow_format(struct ds *ds, const struct flow *flow)
 485 {
 486     struct match match;
 487
 488     match_wc_init(&match, flow);
 489     match_format(&match, ds, flow->skb_priority);
 490 }
 491
 492 void
 493 flow_print(FILE *stream, const struct flow *flow)
 494 {
 495     char *s = flow_to_string(flow);
 496     fputs(s, stream);
 497     free(s);
 498 }
 499 \f
 500 /* flow_wildcards functions. */
 501
 502 /* Initializes 'wc' as a set of wildcards that matches every packet. */
 503 void
 504 flow_wildcards_init_catchall(struct flow_wildcards *wc)
 505 {
 506     memset(&wc->masks, 0, sizeof wc->masks);
 507 }
 508
 509 /* Initializes 'wc' as an exact-match set of wildcards; that is, 'wc' does not
 510  * wildcard any bits or fields. */
 511 void
 512 flow_wildcards_init_exact(struct flow_wildcards *wc)
 513 {
 514     memset(&wc->masks, 0xff, sizeof wc->masks);
 515     memset(wc->masks.zeros, 0, sizeof wc->masks.zeros);
 516 }
 517
 518 /* Returns true if 'wc' matches every packet, false if 'wc' fixes any bits or
 519  * fields. */
 520 bool
 521 flow_wildcards_is_catchall(const struct flow_wildcards *wc)
 522 {
 523     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 524     size_t i;
 525
 526     for (i = 0; i < FLOW_U32S; i++) {
 527         if (wc_u32[i]) {
 528             return false;
 529         }
 530     }
 531     return true;
 532 }
 533
 534 /* Initializes 'dst' as the combination of wildcards in 'src1' and 'src2'.
 535  * That is, a bit or a field is wildcarded in 'dst' if it is wildcarded in
 536  * 'src1' or 'src2' or both.  */
 537 void
 538 flow_wildcards_combine(struct flow_wildcards *dst,
 539                        const struct flow_wildcards *src1,
 540                        const struct flow_wildcards *src2)
 541 {
 542     uint32_t *dst_u32 = (uint32_t *) &dst->masks;
 543     const uint32_t *src1_u32 = (const uint32_t *) &src1->masks;
 544     const uint32_t *src2_u32 = (const uint32_t *) &src2->masks;
 545     size_t i;
 546
 547     for (i = 0; i < FLOW_U32S; i++) {
 548         dst_u32[i] = src1_u32[i] & src2_u32[i];
 549     }
 550 }
 551
 552 /* Returns a hash of the wildcards in 'wc'. */
 553 uint32_t
 554 flow_wildcards_hash(const struct flow_wildcards *wc, uint32_t basis)
 555 {
 556     return flow_hash(&wc->masks, basis);;
 557 }
 558
 559 /* Returns true if 'a' and 'b' represent the same wildcards, false if they are
 560  * different. */
 561 bool
 562 flow_wildcards_equal(const struct flow_wildcards *a,
 563                      const struct flow_wildcards *b)
 564 {
 565     return flow_equal(&a->masks, &b->masks);
 566 }
 567
 568 /* Returns true if at least one bit or field is wildcarded in 'a' but not in
 569  * 'b', false otherwise. */
 570 bool
 571 flow_wildcards_has_extra(const struct flow_wildcards *a,
 572                          const struct flow_wildcards *b)
 573 {
 574     const uint32_t *a_u32 = (const uint32_t *) &a->masks;
 575     const uint32_t *b_u32 = (const uint32_t *) &b->masks;
 576     size_t i;
 577
 578     for (i = 0; i < FLOW_U32S; i++) {
 579         if ((a_u32[i] & b_u32[i]) != b_u32[i]) {
 580             return true;
 581         }
 582     }
 583     return false;
 584 }
 585
 586 /* Returns true if 'a' and 'b' are equal, except that 0-bits (wildcarded bits)
 587  * in 'wc' do not need to be equal in 'a' and 'b'. */
 588 bool
 589 flow_equal_except(const struct flow *a, const struct flow *b,
 590                   const struct flow_wildcards *wc)
 591 {
 592     const uint32_t *a_u32 = (const uint32_t *) a;
 593     const uint32_t *b_u32 = (const uint32_t *) b;
 594     const uint32_t *wc_u32 = (const uint32_t *) &wc->masks;
 595     size_t i;
 596
 597     for (i = 0; i < FLOW_U32S; i++) {
 598         if ((a_u32[i] ^ b_u32[i]) & wc_u32[i]) {
 599             return false;
 600         }
 601     }
 602     return true;
 603 }
 604
 605 /* Sets the wildcard mask for register 'idx' in 'wc' to 'mask'.
 606  * (A 0-bit indicates a wildcard bit.) */
 607 void
 608 flow_wildcards_set_reg_mask(struct flow_wildcards *wc, int idx, uint32_t mask)
 609 {
 610     wc->masks.regs[idx] = mask;
 611 }
 612
 613 /* Hashes 'flow' based on its L2 through L4 protocol information. */
 614 uint32_t
 615 flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis)
 616 {
 617     struct {
 618         union {
 619             ovs_be32 ipv4_addr;
 620             struct in6_addr ipv6_addr;
 621         };
 622         ovs_be16 eth_type;
 623         ovs_be16 vlan_tci;
 624         ovs_be16 tp_port;
 625         uint8_t eth_addr[ETH_ADDR_LEN];
 626         uint8_t ip_proto;
 627     } fields;
 628
 629     int i;
 630
 631     memset(&fields, 0, sizeof fields);
 632     for (i = 0; i < ETH_ADDR_LEN; i++) {
 633         fields.eth_addr[i] = flow->dl_src[i] ^ flow->dl_dst[i];
 634     }
 635     fields.vlan_tci = flow->vlan_tci & htons(VLAN_VID_MASK);
 636     fields.eth_type = flow->dl_type;
 637
 638     /* UDP source and destination port are not taken into account because they
 639      * will not necessarily be symmetric in a bidirectional flow. */
 640     if (fields.eth_type == htons(ETH_TYPE_IP)) {
 641         fields.ipv4_addr = flow->nw_src ^ flow->nw_dst;
 642         fields.ip_proto = flow->nw_proto;
 643         if (fields.ip_proto == IPPROTO_TCP) {
 644             fields.tp_port = flow->tp_src ^ flow->tp_dst;
 645         }
 646     } else if (fields.eth_type == htons(ETH_TYPE_IPV6)) {
 647         const uint8_t *a = &flow->ipv6_src.s6_addr[0];
 648         const uint8_t *b = &flow->ipv6_dst.s6_addr[0];
 649         uint8_t *ipv6_addr = &fields.ipv6_addr.s6_addr[0];
 650
 651         for (i=0; i<16; i++) {
 652             ipv6_addr[i] = a[i] ^ b[i];
 653         }
 654         fields.ip_proto = flow->nw_proto;
 655         if (fields.ip_proto == IPPROTO_TCP) {
 656             fields.tp_port = flow->tp_src ^ flow->tp_dst;
 657         }
 658     }
 659     return hash_bytes(&fields, sizeof fields, basis);
 660 }
 661
 662 /* Hashes the portions of 'flow' designated by 'fields'. */
 663 uint32_t
 664 flow_hash_fields(const struct flow *flow, enum nx_hash_fields fields,
 665                  uint16_t basis)
 666 {
 667     switch (fields) {
 668
 669     case NX_HASH_FIELDS_ETH_SRC:
 670         return hash_bytes(flow->dl_src, sizeof flow->dl_src, basis);
 671
 672     case NX_HASH_FIELDS_SYMMETRIC_L4:
 673         return flow_hash_symmetric_l4(flow, basis);
 674     }
 675
 676     NOT_REACHED();
 677 }
 678
 679 /* Returns a string representation of 'fields'. */
 680 const char *
 681 flow_hash_fields_to_str(enum nx_hash_fields fields)
 682 {
 683     switch (fields) {
 684     case NX_HASH_FIELDS_ETH_SRC: return "eth_src";
 685     case NX_HASH_FIELDS_SYMMETRIC_L4: return "symmetric_l4";
 686     default: return "<unknown>";
 687     }
 688 }
 689
 690 /* Returns true if the value of 'fields' is supported. Otherwise false. */
 691 bool
 692 flow_hash_fields_valid(enum nx_hash_fields fields)
 693 {
 694     return fields == NX_HASH_FIELDS_ETH_SRC
 695         || fields == NX_HASH_FIELDS_SYMMETRIC_L4;
 696 }
 697
 698 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
 699  * OpenFlow 1.0 "dl_vlan" value:
 700  *
 701  *      - If it is in the range 0...4095, 'flow->vlan_tci' is set to match
 702  *        that VLAN.  Any existing PCP match is unchanged (it becomes 0 if
 703  *        'flow' previously matched packets without a VLAN header).
 704  *
 705  *      - If it is OFP_VLAN_NONE, 'flow->vlan_tci' is set to match a packet
 706  *        without a VLAN tag.
 707  *
 708  *      - Other values of 'vid' should not be used. */
 709 void
 710 flow_set_dl_vlan(struct flow *flow, ovs_be16 vid)
 711 {
 712     if (vid == htons(OFP10_VLAN_NONE)) {
 713         flow->vlan_tci = htons(0);
 714     } else {
 715         vid &= htons(VLAN_VID_MASK);
 716         flow->vlan_tci &= ~htons(VLAN_VID_MASK);
 717         flow->vlan_tci |= htons(VLAN_CFI) | vid;
 718     }
 719 }
 720
 721 /* Sets the VLAN VID that 'flow' matches to 'vid', which is interpreted as an
 722  * OpenFlow 1.2 "vlan_vid" value, that is, the low 13 bits of 'vlan_tci' (VID
 723  * plus CFI). */
 724 void
 725 flow_set_vlan_vid(struct flow *flow, ovs_be16 vid)
 726 {
 727     ovs_be16 mask = htons(VLAN_VID_MASK | VLAN_CFI);
 728     flow->vlan_tci &= ~mask;
 729     flow->vlan_tci |= vid & mask;
 730 }
 731
 732 /* Sets the VLAN PCP that 'flow' matches to 'pcp', which should be in the
 733  * range 0...7.
 734  *
 735  * This function has no effect on the VLAN ID that 'flow' matches.
 736  *
 737  * After calling this function, 'flow' will not match packets without a VLAN
 738  * header. */
 739 void
 740 flow_set_vlan_pcp(struct flow *flow, uint8_t pcp)
 741 {
 742     pcp &= 0x07;
 743     flow->vlan_tci &= ~htons(VLAN_PCP_MASK);
 744     flow->vlan_tci |= htons((pcp << VLAN_PCP_SHIFT) | VLAN_CFI);
 745 }
 746
 747 /* Puts into 'b' a packet that flow_extract() would parse as having the given
 748  * 'flow'.
 749  *
 750  * (This is useful only for testing, obviously, and the packet isn't really
 751  * valid. It hasn't got some checksums filled in, for one, and lots of fields
 752  * are just zeroed.) */
 753 void
 754 flow_compose(struct ofpbuf *b, const struct flow *flow)
 755 {
 756     eth_compose(b, flow->dl_dst, flow->dl_src, ntohs(flow->dl_type), 0);
 757     if (flow->dl_type == htons(FLOW_DL_TYPE_NONE)) {
 758         struct eth_header *eth = b->l2;
 759         eth->eth_type = htons(b->size);
 760         return;
 761     }
 762
 763     if (flow->vlan_tci & htons(VLAN_CFI)) {
 764         eth_push_vlan(b, flow->vlan_tci);
 765     }
 766
 767     if (flow->dl_type == htons(ETH_TYPE_IP)) {
 768         struct ip_header *ip;
 769
 770         b->l3 = ip = ofpbuf_put_zeros(b, sizeof *ip);
 771         ip->ip_ihl_ver = IP_IHL_VER(5, 4);
 772         ip->ip_tos = flow->nw_tos;
 773         ip->ip_proto = flow->nw_proto;
 774         ip->ip_src = flow->nw_src;
 775         ip->ip_dst = flow->nw_dst;
 776
 777         if (flow->nw_frag & FLOW_NW_FRAG_ANY) {
 778             ip->ip_frag_off |= htons(IP_MORE_FRAGMENTS);
 779             if (flow->nw_frag & FLOW_NW_FRAG_LATER) {
 780                 ip->ip_frag_off |= htons(100);
 781             }
 782         }
 783         if (!(flow->nw_frag & FLOW_NW_FRAG_ANY)
 784             || !(flow->nw_frag & FLOW_NW_FRAG_LATER)) {
 785             if (flow->nw_proto == IPPROTO_TCP) {
 786                 struct tcp_header *tcp;
 787
 788                 b->l4 = tcp = ofpbuf_put_zeros(b, sizeof *tcp);
 789                 tcp->tcp_src = flow->tp_src;
 790                 tcp->tcp_dst = flow->tp_dst;
 791                 tcp->tcp_ctl = TCP_CTL(0, 5);
 792             } else if (flow->nw_proto == IPPROTO_UDP) {
 793                 struct udp_header *udp;
 794
 795                 b->l4 = udp = ofpbuf_put_zeros(b, sizeof *udp);
 796                 udp->udp_src = flow->tp_src;
 797                 udp->udp_dst = flow->tp_dst;
 798             } else if (flow->nw_proto == IPPROTO_ICMP) {
 799                 struct icmp_header *icmp;
 800
 801                 b->l4 = icmp = ofpbuf_put_zeros(b, sizeof *icmp);
 802                 icmp->icmp_type = ntohs(flow->tp_src);
 803                 icmp->icmp_code = ntohs(flow->tp_dst);
 804                 icmp->icmp_csum = csum(icmp, ICMP_HEADER_LEN);
 805             }
 806         }
 807
 808         ip = b->l3;
 809         ip->ip_tot_len = htons((uint8_t *) b->data + b->size
 810                                - (uint8_t *) b->l3);
 811         ip->ip_csum = csum(ip, sizeof *ip);
 812     } else if (flow->dl_type == htons(ETH_TYPE_IPV6)) {
 813         /* XXX */
 814     } else if (flow->dl_type == htons(ETH_TYPE_ARP)) {
 815         struct arp_eth_header *arp;
 816
 817         b->l3 = arp = ofpbuf_put_zeros(b, sizeof *arp);
 818         arp->ar_hrd = htons(1);
 819         arp->ar_pro = htons(ETH_TYPE_IP);
 820         arp->ar_hln = ETH_ADDR_LEN;
 821         arp->ar_pln = 4;
 822         arp->ar_op = htons(flow->nw_proto);
 823
 824         if (flow->nw_proto == ARP_OP_REQUEST ||
 825             flow->nw_proto == ARP_OP_REPLY) {
 826             arp->ar_spa = flow->nw_src;
 827             arp->ar_tpa = flow->nw_dst;
 828             memcpy(arp->ar_sha, flow->arp_sha, ETH_ADDR_LEN);
 829             memcpy(arp->ar_tha, flow->arp_tha, ETH_ADDR_LEN);
 830         }
 831     }
 832 }
 833 \f
 834 /* Compressed flow. */
 835
 836 static int
 837 miniflow_n_values(const struct miniflow *flow)
 838 {
 839     int n, i;
 840
 841     n = 0;
 842     for (i = 0; i < MINI_N_MAPS; i++) {
 843         n += popcount(flow->map[i]);
 844     }
 845     return n;
 846 }
 847
 848 static uint32_t *
 849 miniflow_alloc_values(struct miniflow *flow, int n)
 850 {
 851     if (n <= MINI_N_INLINE) {
 852         return flow->inline_values;
 853     } else {
 854         COVERAGE_INC(miniflow_malloc);
 855         return xmalloc(n * sizeof *flow->values);
 856     }
 857 }
 858
 859 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
 860  * with miniflow_destroy(). */
 861 void
 862 miniflow_init(struct miniflow *dst, const struct flow *src)
 863 {
 864     const uint32_t *src_u32 = (const uint32_t *) src;
 865     unsigned int ofs;
 866     unsigned int i;
 867     int n;
 868
 869     /* Initialize dst->map, counting the number of nonzero elements. */
 870     n = 0;
 871     memset(dst->map, 0, sizeof dst->map);
 872     for (i = 0; i < FLOW_U32S; i++) {
 873         if (src_u32[i]) {
 874             dst->map[i / 32] |= 1u << (i % 32);
 875             n++;
 876         }
 877     }
 878
 879     /* Initialize dst->values. */
 880     dst->values = miniflow_alloc_values(dst, n);
 881     ofs = 0;
 882     for (i = 0; i < MINI_N_MAPS; i++) {
 883         uint32_t map;
 884
 885         for (map = dst->map[i]; map; map = zero_rightmost_1bit(map)) {
 886             dst->values[ofs++] = src_u32[raw_ctz(map) + i * 32];
 887         }
 888     }
 889 }
 890
 891 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
 892  * with miniflow_destroy(). */
 893 void
 894 miniflow_clone(struct miniflow *dst, const struct miniflow *src)
 895 {
 896     int n = miniflow_n_values(src);
 897     memcpy(dst->map, src->map, sizeof dst->map);
 898     dst->values = miniflow_alloc_values(dst, n);
 899     memcpy(dst->values, src->values, n * sizeof *dst->values);
 900 }
 901
 902 /* Frees any memory owned by 'flow'.  Does not free the storage in which 'flow'
 903  * itself resides; the caller is responsible for that. */
 904 void
 905 miniflow_destroy(struct miniflow *flow)
 906 {
 907     if (flow->values != flow->inline_values) {
 908         free(flow->values);
 909     }
 910 }
 911
 912 /* Initializes 'dst' as a copy of 'src'. */
 913 void
 914 miniflow_expand(const struct miniflow *src, struct flow *dst)
 915 {
 916     uint32_t *dst_u32 = (uint32_t *) dst;
 917     int ofs;
 918     int i;
 919
 920     memset(dst_u32, 0, sizeof *dst);
 921
 922     ofs = 0;
 923     for (i = 0; i < MINI_N_MAPS; i++) {
 924         uint32_t map;
 925
 926         for (map = src->map[i]; map; map = zero_rightmost_1bit(map)) {
 927             dst_u32[raw_ctz(map) + i * 32] = src->values[ofs++];
 928         }
 929     }
 930 }
 931
 932 static const uint32_t *
 933 miniflow_get__(const struct miniflow *flow, unsigned int u32_ofs)
 934 {
 935     if (!(flow->map[u32_ofs / 32] & (1u << (u32_ofs % 32)))) {
 936         static const uint32_t zero = 0;
 937         return &zero;
 938     } else {
 939         const uint32_t *p = flow->values;
 940
 941         BUILD_ASSERT(MINI_N_MAPS == 2);
 942         if (u32_ofs < 32) {
 943             p += popcount(flow->map[0] & ((1u << u32_ofs) - 1));
 944         } else {
 945             p += popcount(flow->map[0]);
 946             p += popcount(flow->map[1] & ((1u << (u32_ofs - 32)) - 1));
 947         }
 948         return p;
 949     }
 950 }
 951
 952 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'flow'
 953  * were expanded into a "struct flow". */
 954 uint32_t
 955 miniflow_get(const struct miniflow *flow, unsigned int u32_ofs)
 956 {
 957     return *miniflow_get__(flow, u32_ofs);
 958 }
 959
 960 /* Returns the ovs_be16 that would be at byte offset 'u8_ofs' if 'flow' were
 961  * expanded into a "struct flow". */
 962 static ovs_be16
 963 miniflow_get_be16(const struct miniflow *flow, unsigned int u8_ofs)
 964 {
 965     const uint32_t *u32p = miniflow_get__(flow, u8_ofs / 4);
 966     const ovs_be16 *be16p = (const ovs_be16 *) u32p;
 967     return be16p[u8_ofs % 4 != 0];
 968 }
 969
 970 /* Returns the VID within the vlan_tci member of the "struct flow" represented
 971  * by 'flow'. */
 972 uint16_t
 973 miniflow_get_vid(const struct miniflow *flow)
 974 {
 975     ovs_be16 tci = miniflow_get_be16(flow, offsetof(struct flow, vlan_tci));
 976     return vlan_tci_to_vid(tci);
 977 }
 978
 979 /* Returns true if 'a' and 'b' are the same flow, false otherwise.  */
 980 bool
 981 miniflow_equal(const struct miniflow *a, const struct miniflow *b)
 982 {
 983     int i;
 984
 985     for (i = 0; i < MINI_N_MAPS; i++) {
 986         if (a->map[i] != b->map[i]) {
 987             return false;
 988         }
 989     }
 990
 991     return !memcmp(a->values, b->values,
 992                    miniflow_n_values(a) * sizeof *a->values);
 993 }
 994
 995 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
 996  * in 'mask', false if they differ. */
 997 bool
 998 miniflow_equal_in_minimask(const struct miniflow *a, const struct miniflow *b,
 999                            const struct minimask *mask)
1000 {
1001     const uint32_t *p;
1002     int i;
1003
1004     p = mask->masks.values;
1005     for (i = 0; i < MINI_N_MAPS; i++) {
1006         uint32_t map;
1007
1008         for (map = mask->masks.map[i]; map; map = zero_rightmost_1bit(map)) {
1009             int ofs = raw_ctz(map) + i * 32;
1010
1011             if ((miniflow_get(a, ofs) ^ miniflow_get(b, ofs)) & *p) {
1012                 return false;
1013             }
1014             p++;
1015         }
1016     }
1017
1018     return true;
1019 }
1020
1021 /* Returns true if 'a' and 'b' are equal at the places where there are 1-bits
1022  * in 'mask', false if they differ. */
1023 bool
1024 miniflow_equal_flow_in_minimask(const struct miniflow *a, const struct flow *b,
1025                                 const struct minimask *mask)
1026 {
1027     const uint32_t *b_u32 = (const uint32_t *) b;
1028     const uint32_t *p;
1029     int i;
1030
1031     p = mask->masks.values;
1032     for (i = 0; i < MINI_N_MAPS; i++) {
1033         uint32_t map;
1034
1035         for (map = mask->masks.map[i]; map; map = zero_rightmost_1bit(map)) {
1036             int ofs = raw_ctz(map) + i * 32;
1037
1038             if ((miniflow_get(a, ofs) ^ b_u32[ofs]) & *p) {
1039                 return false;
1040             }
1041             p++;
1042         }
1043     }
1044
1045     return true;
1046 }
1047
1048 /* Returns a hash value for 'flow', given 'basis'. */
1049 uint32_t
1050 miniflow_hash(const struct miniflow *flow, uint32_t basis)
1051 {
1052     BUILD_ASSERT_DECL(MINI_N_MAPS == 2);
1053     return hash_3words(flow->map[0], flow->map[1],
1054                        hash_words(flow->values, miniflow_n_values(flow),
1055                                   basis));
1056 }
1057
1058 /* Returns a hash value for the bits of 'flow' where there are 1-bits in
1059  * 'mask', given 'basis'.
1060  *
1061  * The hash values returned by this function are the same as those returned by
1062  * flow_hash_in_minimask(), only the form of the arguments differ. */
1063 uint32_t
1064 miniflow_hash_in_minimask(const struct miniflow *flow,
1065                           const struct minimask *mask, uint32_t basis)
1066 {
1067     const uint32_t *p = mask->masks.values;
1068     uint32_t hash;
1069     int i;
1070
1071     hash = basis;
1072     for (i = 0; i < MINI_N_MAPS; i++) {
1073         uint32_t map;
1074
1075         for (map = mask->masks.map[i]; map; map = zero_rightmost_1bit(map)) {
1076             int ofs = raw_ctz(map) + i * 32;
1077
1078             hash = mhash_add(hash, miniflow_get(flow, ofs) & *p);
1079             p++;
1080         }
1081     }
1082
1083     return mhash_finish(hash, p - mask->masks.values);
1084 }
1085
1086 /* Returns a hash value for the bits of 'flow' where there are 1-bits in
1087  * 'mask', given 'basis'.
1088  *
1089  * The hash values returned by this function are the same as those returned by
1090  * miniflow_hash_in_minimask(), only the form of the arguments differ. */
1091 uint32_t
1092 flow_hash_in_minimask(const struct flow *flow, const struct minimask *mask,
1093                       uint32_t basis)
1094 {
1095     const uint32_t *flow_u32 = (const uint32_t *) flow;
1096     const uint32_t *p = mask->masks.values;
1097     uint32_t hash;
1098     int i;
1099
1100     hash = basis;
1101     for (i = 0; i < MINI_N_MAPS; i++) {
1102         uint32_t map;
1103
1104         for (map = mask->masks.map[i]; map; map = zero_rightmost_1bit(map)) {
1105             int ofs = raw_ctz(map) + i * 32;
1106
1107             hash = mhash_add(hash, flow_u32[ofs] & *p);
1108             p++;
1109         }
1110     }
1111
1112     return mhash_finish(hash, p - mask->masks.values);
1113 }
1114 \f
1115 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1116  * with minimask_destroy(). */
1117 void
1118 minimask_init(struct minimask *mask, const struct flow_wildcards *wc)
1119 {
1120     miniflow_init(&mask->masks, &wc->masks);
1121 }
1122
1123 /* Initializes 'dst' as a copy of 'src'.  The caller must eventually free 'dst'
1124  * with minimask_destroy(). */
1125 void
1126 minimask_clone(struct minimask *dst, const struct minimask *src)
1127 {
1128     miniflow_clone(&dst->masks, &src->masks);
1129 }
1130
1131 /* Initializes 'dst_' as the bit-wise "and" of 'a_' and 'b_'.
1132  *
1133  * The caller must provide room for FLOW_U32S "uint32_t"s in 'storage', for use
1134  * by 'dst_'.  The caller must *not* free 'dst_' with minimask_destroy(). */
1135 void
1136 minimask_combine(struct minimask *dst_,
1137                  const struct minimask *a_, const struct minimask *b_,
1138                  uint32_t storage[FLOW_U32S])
1139 {
1140     struct miniflow *dst = &dst_->masks;
1141     const struct miniflow *a = &a_->masks;
1142     const struct miniflow *b = &b_->masks;
1143     int i, n;
1144
1145     n = 0;
1146     dst->values = storage;
1147     for (i = 0; i < MINI_N_MAPS; i++) {
1148         uint32_t map;
1149
1150         dst->map[i] = 0;
1151         for (map = a->map[i] & b->map[i]; map;
1152              map = zero_rightmost_1bit(map)) {
1153             int ofs = raw_ctz(map) + i * 32;
1154             uint32_t mask = miniflow_get(a, ofs) & miniflow_get(b, ofs);
1155
1156             if (mask) {
1157                 dst->map[i] |= rightmost_1bit(map);
1158                 dst->values[n++] = mask;
1159             }
1160         }
1161     }
1162 }
1163
1164 /* Frees any memory owned by 'mask'.  Does not free the storage in which 'mask'
1165  * itself resides; the caller is responsible for that. */
1166 void
1167 minimask_destroy(struct minimask *mask)
1168 {
1169     miniflow_destroy(&mask->masks);
1170 }
1171
1172 /* Initializes 'dst' as a copy of 'src'. */
1173 void
1174 minimask_expand(const struct minimask *mask, struct flow_wildcards *wc)
1175 {
1176     miniflow_expand(&mask->masks, &wc->masks);
1177 }
1178
1179 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'mask'
1180  * were expanded into a "struct flow_wildcards". */
1181 uint32_t
1182 minimask_get(const struct minimask *mask, unsigned int u32_ofs)
1183 {
1184     return miniflow_get(&mask->masks, u32_ofs);
1185 }
1186
1187 /* Returns the VID mask within the vlan_tci member of the "struct
1188  * flow_wildcards" represented by 'mask'. */
1189 uint16_t
1190 minimask_get_vid_mask(const struct minimask *mask)
1191 {
1192     return miniflow_get_vid(&mask->masks);
1193 }
1194
1195 /* Returns true if 'a' and 'b' are the same flow mask, false otherwise.  */
1196 bool
1197 minimask_equal(const struct minimask *a, const struct minimask *b)
1198 {
1199     return miniflow_equal(&a->masks, &b->masks);
1200 }
1201
1202 /* Returns a hash value for 'mask', given 'basis'. */
1203 uint32_t
1204 minimask_hash(const struct minimask *mask, uint32_t basis)
1205 {
1206     return miniflow_hash(&mask->masks, basis);
1207 }
1208
1209 /* Returns true if at least one bit is wildcarded in 'a_' but not in 'b_',
1210  * false otherwise. */
1211 bool
1212 minimask_has_extra(const struct minimask *a_, const struct minimask *b_)
1213 {
1214     const struct miniflow *a = &a_->masks;
1215     const struct miniflow *b = &b_->masks;
1216     int i;
1217
1218     for (i = 0; i < MINI_N_MAPS; i++) {
1219         uint32_t map;
1220
1221         for (map = a->map[i] | b->map[i]; map;
1222              map = zero_rightmost_1bit(map)) {
1223             int ofs = raw_ctz(map) + i * 32;
1224             uint32_t a_u32 = miniflow_get(a, ofs);
1225             uint32_t b_u32 = miniflow_get(b, ofs);
1226
1227             if ((a_u32 & b_u32) != b_u32) {
1228                 return true;
1229             }
1230         }
1231     }
1232
1233     return false;
1234 }
1235
1236 /* Returns true if 'mask' matches every packet, false if 'mask' fixes any bits
1237  * or fields. */
1238 bool
1239 minimask_is_catchall(const struct minimask *mask_)
1240 {
1241     const struct miniflow *mask = &mask_->masks;
1242
1243     BUILD_ASSERT(MINI_N_MAPS == 2);
1244     return !(mask->map[0] | mask->map[1]);
1245 }