lib/flow.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 #ifndef FLOW_H
  17 #define FLOW_H 1
  18
  19 #include <sys/types.h>
  20 #include <netinet/in.h>
  21 #include <stdbool.h>
  22 #include <stdint.h>
  23 #include <string.h>
  24 #include "byte-order.h"
  25 #include "openflow/nicira-ext.h"
  26 #include "openflow/openflow.h"
  27 #include "packets.h"
  28 #include "hash.h"
  29 #include "util.h"
  30
  31 struct dpif_flow_stats;
  32 struct ds;
  33 struct flow_wildcards;
  34 struct minimask;
  35 struct ofpbuf;
  36 struct pkt_metadata;
  37
  38 /* This sequence number should be incremented whenever anything involving flows
  39  * or the wildcarding of flows changes.  This will cause build assertion
  40  * failures in places which likely need to be updated. */
  41 #define FLOW_WC_SEQ 28
  42
  43 /* Number of Open vSwitch extension 32-bit registers. */
  44 #define FLOW_N_REGS 8
  45 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
  46
  47 /* Number of OpenFlow 1.5+ 64-bit registers.
  48  *
  49  * Each of these overlays a pair of Open vSwitch 32-bit registers, so there
  50  * are half as many of them.*/
  51 #define FLOW_N_XREGS (FLOW_N_REGS / 2)
  52
  53 /* Used for struct flow's dl_type member for frames that have no Ethernet
  54  * type, that is, pure 802.2 frames. */
  55 #define FLOW_DL_TYPE_NONE 0x5ff
  56
  57 /* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */
  58 #define FLOW_NW_FRAG_ANY   (1 << 0) /* Set for any IP frag. */
  59 #define FLOW_NW_FRAG_LATER (1 << 1) /* Set for IP frag with nonzero offset. */
  60 #define FLOW_NW_FRAG_MASK  (FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER)
  61
  62 BUILD_ASSERT_DECL(FLOW_NW_FRAG_ANY == NX_IP_FRAG_ANY);
  63 BUILD_ASSERT_DECL(FLOW_NW_FRAG_LATER == NX_IP_FRAG_LATER);
  64
  65 #define FLOW_TNL_F_DONT_FRAGMENT (1 << 0)
  66 #define FLOW_TNL_F_CSUM (1 << 1)
  67 #define FLOW_TNL_F_KEY (1 << 2)
  68 #define FLOW_TNL_F_OAM (1 << 3)
  69
  70 #define FLOW_TNL_F_MASK ((1 << 4) - 1)
  71
  72 const char *flow_tun_flag_to_string(uint32_t flags);
  73
  74 /* Maximum number of supported MPLS labels. */
  75 #define FLOW_MAX_MPLS_LABELS 3
  76
  77 /*
  78  * A flow in the network.
  79  *
  80  * Must be initialized to all zeros to make any compiler-induced padding
  81  * zeroed.  Helps also in keeping unused fields (such as mutually exclusive
  82  * IPv4 and IPv6 addresses) zeroed out.
  83  *
  84  * The meaning of 'in_port' is context-dependent.  In most cases, it is a
  85  * 16-bit OpenFlow 1.0 port number.  In the software datapath interface (dpif)
  86  * layer and its implementations (e.g. dpif-netlink, dpif-netdev), it is
  87  * instead a 32-bit datapath port number.
  88  *
  89  * The fields are organized in four segments to facilitate staged lookup, where
  90  * lower layer fields are first used to determine if the later fields need to
  91  * be looked at.  This enables better wildcarding for datapath flows.
  92  *
  93  * NOTE: Order of the fields is significant, any change in the order must be
  94  * reflected in miniflow_extract()!
  95  */
  96 struct flow {
  97     /* Metadata */
  98     struct flow_tnl tunnel;     /* Encapsulating tunnel parameters. */
  99     ovs_be64 metadata;          /* OpenFlow Metadata. */
 100     uint32_t regs[FLOW_N_REGS]; /* Registers. */
 101     uint32_t skb_priority;      /* Packet priority for QoS. */
 102     uint32_t pkt_mark;          /* Packet mark. */
 103     uint32_t recirc_id;         /* Must be exact match. */
 104     union flow_in_port in_port; /* Input port.*/
 105     ofp_port_t actset_output;   /* Output port in action set. */
 106     ovs_be16 pad1;              /* Pad to 32 bits. */
 107
 108     /* L2, Order the same as in the Ethernet header! */
 109     uint8_t dl_dst[ETH_ADDR_LEN]; /* Ethernet destination address. */
 110     uint8_t dl_src[ETH_ADDR_LEN]; /* Ethernet source address. */
 111     ovs_be16 dl_type;           /* Ethernet frame type. */
 112     ovs_be16 vlan_tci;          /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
 113     ovs_be32 mpls_lse[FLOW_MAX_MPLS_LABELS]; /* MPLS label stack entry. */
 114
 115     /* L3 */
 116     struct in6_addr ipv6_src;   /* IPv6 source address. */
 117     struct in6_addr ipv6_dst;   /* IPv6 destination address. */
 118     ovs_be32 ipv6_label;        /* IPv6 flow label. */
 119     ovs_be32 nw_src;            /* IPv4 source address. */
 120     ovs_be32 nw_dst;            /* IPv4 destination address. */
 121     uint8_t nw_frag;            /* FLOW_FRAG_* flags. */
 122     uint8_t nw_tos;             /* IP ToS (including DSCP and ECN). */
 123     uint8_t nw_ttl;             /* IP TTL/Hop Limit. */
 124     uint8_t nw_proto;           /* IP protocol or low 8 bits of ARP opcode. */
 125     uint8_t arp_sha[ETH_ADDR_LEN]; /* ARP/ND source hardware address. */
 126     uint8_t arp_tha[ETH_ADDR_LEN]; /* ARP/ND target hardware address. */
 127     struct in6_addr nd_target;  /* IPv6 neighbor discovery (ND) target. */
 128     ovs_be16 tcp_flags;         /* TCP flags. With L3 to avoid matching L4. */
 129     ovs_be16 pad2;              /* Pad to 32 bits. */
 130
 131     /* L4 */
 132     ovs_be16 tp_src;            /* TCP/UDP/SCTP source port. */
 133     ovs_be16 tp_dst;            /* TCP/UDP/SCTP destination port. */
 134     ovs_be32 igmp_group_ip4;    /* IGMP group IPv4 address */
 135     uint32_t dp_hash;           /* Datapath computed hash value. The exact
 136                                  * computation is opaque to the user space.
 137                                  * Keep last for BUILD_ASSERT_DECL below. */
 138 };
 139 BUILD_ASSERT_DECL(sizeof(struct flow) % 4 == 0);
 140
 141 #define FLOW_U32S (sizeof(struct flow) / 4)
 142
 143 /* Some flow fields are mutually exclusive or only appear within the flow
 144  * pipeline.  IPv6 headers are bigger than IPv4 and MPLS, and IPv6 ND packets
 145  * are bigger than TCP,UDP and IGMP packets. */
 146 #define FLOW_MAX_PACKET_U32S (FLOW_U32S                                   \
 147     /* Unused in datapath */  - FLOW_U32_SIZE(regs)                       \
 148                               - FLOW_U32_SIZE(metadata)                   \
 149                               - FLOW_U32_SIZE(actset_output)              \
 150     /* L2.5/3 */              - FLOW_U32_SIZE(nw_src)                     \
 151                               - FLOW_U32_SIZE(nw_dst)                     \
 152                               - FLOW_U32_SIZE(mpls_lse)                   \
 153     /* L4 */                  - FLOW_U32_SIZE(tcp_flags) /* incl. pad. */ \
 154                               - FLOW_U32_SIZE(igmp_group_ip4)             \
 155                              )
 156
 157 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
 158 BUILD_ASSERT_DECL(offsetof(struct flow, dp_hash) + sizeof(uint32_t)
 159                   == sizeof(struct flow_tnl) + 180
 160                   && FLOW_WC_SEQ == 28);
 161
 162 /* Incremental points at which flow classification may be performed in
 163  * segments.
 164  * This is located here since this is dependent on the structure of the
 165  * struct flow defined above:
 166  * Each offset must be on a distinct, successive U32 boundary strictly
 167  * within the struct flow. */
 168 enum {
 169     FLOW_SEGMENT_1_ENDS_AT = offsetof(struct flow, dl_dst),
 170     FLOW_SEGMENT_2_ENDS_AT = offsetof(struct flow, ipv6_src),
 171     FLOW_SEGMENT_3_ENDS_AT = offsetof(struct flow, tp_src),
 172 };
 173 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT % 4 == 0);
 174 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT % 4 == 0);
 175 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT % 4 == 0);
 176 BUILD_ASSERT_DECL(                     0 < FLOW_SEGMENT_1_ENDS_AT);
 177 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT < FLOW_SEGMENT_2_ENDS_AT);
 178 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT < FLOW_SEGMENT_3_ENDS_AT);
 179 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT < sizeof(struct flow));
 180
 181 extern const uint8_t flow_segment_u32s[];
 182
 183 /* Represents the metadata fields of struct flow. */
 184 struct flow_metadata {
 185     uint32_t dp_hash;                /* Datapath computed hash field. */
 186     uint32_t recirc_id;              /* Recirculation ID. */
 187     ovs_be64 tun_id;                 /* Encapsulating tunnel ID. */
 188     ovs_be32 tun_src;                /* Tunnel outer IPv4 src addr */
 189     ovs_be32 tun_dst;                /* Tunnel outer IPv4 dst addr */
 190     ovs_be64 metadata;               /* OpenFlow 1.1+ metadata field. */
 191     uint32_t regs[FLOW_N_REGS];      /* Registers. */
 192     uint32_t pkt_mark;               /* Packet mark. */
 193     ofp_port_t in_port;              /* OpenFlow port or zero. */
 194 };
 195
 196 void flow_extract(struct ofpbuf *, const struct pkt_metadata *md,
 197                   struct flow *);
 198
 199 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
 200 void flow_unwildcard_tp_ports(const struct flow *, struct flow_wildcards *);
 201 void flow_get_metadata(const struct flow *, struct flow_metadata *);
 202
 203 char *flow_to_string(const struct flow *);
 204 void format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
 205                   uint32_t flags, char del);
 206 void format_flags_masked(struct ds *ds, const char *name,
 207                          const char *(*bit_to_string)(uint32_t),
 208                          uint32_t flags, uint32_t mask);
 209
 210 void flow_format(struct ds *, const struct flow *);
 211 void flow_print(FILE *, const struct flow *);
 212 static inline int flow_compare_3way(const struct flow *, const struct flow *);
 213 static inline bool flow_equal(const struct flow *, const struct flow *);
 214 static inline size_t flow_hash(const struct flow *, uint32_t basis);
 215
 216 void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
 217 void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
 218 void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
 219
 220 int flow_count_mpls_labels(const struct flow *, struct flow_wildcards *);
 221 int flow_count_common_mpls_labels(const struct flow *a, int an,
 222                                   const struct flow *b, int bn,
 223                                   struct flow_wildcards *wc);
 224 void flow_push_mpls(struct flow *, int n, ovs_be16 mpls_eth_type,
 225                     struct flow_wildcards *);
 226 bool flow_pop_mpls(struct flow *, int n, ovs_be16 eth_type,
 227                    struct flow_wildcards *);
 228 void flow_set_mpls_label(struct flow *, int idx, ovs_be32 label);
 229 void flow_set_mpls_ttl(struct flow *, int idx, uint8_t ttl);
 230 void flow_set_mpls_tc(struct flow *, int idx, uint8_t tc);
 231 void flow_set_mpls_bos(struct flow *, int idx, uint8_t stack);
 232 void flow_set_mpls_lse(struct flow *, int idx, ovs_be32 lse);
 233
 234 void flow_compose(struct ofpbuf *, const struct flow *);
 235
 236 static inline uint64_t
 237 flow_get_xreg(const struct flow *flow, int idx)
 238 {
 239     return ((uint64_t) flow->regs[idx * 2] << 32) | flow->regs[idx * 2 + 1];
 240 }
 241
 242 static inline void
 243 flow_set_xreg(struct flow *flow, int idx, uint64_t value)
 244 {
 245     flow->regs[idx * 2] = value >> 32;
 246     flow->regs[idx * 2 + 1] = value;
 247 }
 248
 249 static inline int
 250 flow_compare_3way(const struct flow *a, const struct flow *b)
 251 {
 252     return memcmp(a, b, sizeof *a);
 253 }
 254
 255 static inline bool
 256 flow_equal(const struct flow *a, const struct flow *b)
 257 {
 258     return !flow_compare_3way(a, b);
 259 }
 260
 261 static inline size_t
 262 flow_hash(const struct flow *flow, uint32_t basis)
 263 {
 264     return hash_words((const uint32_t *) flow, sizeof *flow / 4, basis);
 265 }
 266
 267 static inline uint16_t
 268 ofp_to_u16(ofp_port_t ofp_port)
 269 {
 270     return (OVS_FORCE uint16_t) ofp_port;
 271 }
 272
 273 static inline uint32_t
 274 odp_to_u32(odp_port_t odp_port)
 275 {
 276     return (OVS_FORCE uint32_t) odp_port;
 277 }
 278
 279 static inline uint32_t
 280 ofp11_to_u32(ofp11_port_t ofp11_port)
 281 {
 282     return (OVS_FORCE uint32_t) ofp11_port;
 283 }
 284
 285 static inline ofp_port_t
 286 u16_to_ofp(uint16_t port)
 287 {
 288     return OFP_PORT_C(port);
 289 }
 290
 291 static inline odp_port_t
 292 u32_to_odp(uint32_t port)
 293 {
 294     return ODP_PORT_C(port);
 295 }
 296
 297 static inline ofp11_port_t
 298 u32_to_ofp11(uint32_t port)
 299 {
 300     return OFP11_PORT_C(port);
 301 }
 302
 303 static inline uint32_t
 304 hash_ofp_port(ofp_port_t ofp_port)
 305 {
 306     return hash_int(ofp_to_u16(ofp_port), 0);
 307 }
 308
 309 static inline uint32_t
 310 hash_odp_port(odp_port_t odp_port)
 311 {
 312     return hash_int(odp_to_u32(odp_port), 0);
 313 }
 314 \f
 315 /* Wildcards for a flow.
 316  *
 317  * A 1-bit in each bit in 'masks' indicates that the corresponding bit of
 318  * the flow is significant (must match).  A 0-bit indicates that the
 319  * corresponding bit of the flow is wildcarded (need not match). */
 320 struct flow_wildcards {
 321     struct flow masks;
 322 };
 323
 324 #define WC_MASK_FIELD(WC, FIELD) \
 325     memset(&(WC)->masks.FIELD, 0xff, sizeof (WC)->masks.FIELD)
 326 #define WC_UNMASK_FIELD(WC, FIELD) \
 327     memset(&(WC)->masks.FIELD, 0, sizeof (WC)->masks.FIELD)
 328
 329 void flow_wildcards_init_catchall(struct flow_wildcards *);
 330
 331 void flow_wildcards_init_for_packet(struct flow_wildcards *,
 332                                     const struct flow *);
 333 uint64_t flow_wc_map(const struct flow *);
 334
 335 void flow_wildcards_clear_non_packet_fields(struct flow_wildcards *);
 336
 337 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
 338
 339 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
 340                                  int idx, uint32_t mask);
 341 void flow_wildcards_set_xreg_mask(struct flow_wildcards *,
 342                                   int idx, uint64_t mask);
 343
 344 void flow_wildcards_and(struct flow_wildcards *dst,
 345                         const struct flow_wildcards *src1,
 346                         const struct flow_wildcards *src2);
 347 void flow_wildcards_or(struct flow_wildcards *dst,
 348                        const struct flow_wildcards *src1,
 349                        const struct flow_wildcards *src2);
 350 bool flow_wildcards_has_extra(const struct flow_wildcards *,
 351                               const struct flow_wildcards *);
 352 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
 353 bool flow_wildcards_equal(const struct flow_wildcards *,
 354                           const struct flow_wildcards *);
 355 uint32_t flow_hash_5tuple(const struct flow *flow, uint32_t basis);
 356 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
 357
 358 /* Initialize a flow with random fields that matter for nx_hash_fields. */
 359 void flow_random_hash_fields(struct flow *);
 360 void flow_mask_hash_fields(const struct flow *, struct flow_wildcards *,
 361                            enum nx_hash_fields);
 362 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
 363                           uint16_t basis);
 364 const char *flow_hash_fields_to_str(enum nx_hash_fields);
 365 bool flow_hash_fields_valid(enum nx_hash_fields);
 366
 367 uint32_t flow_hash_in_wildcards(const struct flow *,
 368                                 const struct flow_wildcards *,
 369                                 uint32_t basis);
 370
 371 bool flow_equal_except(const struct flow *a, const struct flow *b,
 372                        const struct flow_wildcards *);
 373 \f
 374 /* Compressed flow. */
 375
 376 /* Number of 32-bit words present in struct miniflow. */
 377 #define MINI_N_INLINE 8
 378
 379 /* Maximum number of 32-bit words supported. */
 380 BUILD_ASSERT_DECL(FLOW_U32S <= 63);
 381
 382 /* A sparse representation of a "struct flow".
 383  *
 384  * A "struct flow" is fairly large and tends to be mostly zeros.  Sparse
 385  * representation has two advantages.  First, it saves memory.  Second, it
 386  * saves time when the goal is to iterate over only the nonzero parts of the
 387  * struct.
 388  *
 389  * The 'map' member holds one bit for each uint32_t in a "struct flow".  Each
 390  * 0-bit indicates that the corresponding uint32_t is zero, each 1-bit that it
 391  * *may* be nonzero (see below how this applies to minimasks).
 392  *
 393  * The 'values_inline' boolean member indicates that the values are at
 394  * 'inline_values'.  If 'values_inline' is zero, then the values are
 395  * offline at 'offline_values'.  In either case, values is an array that has
 396  * one element for each 1-bit in 'map'.  The least-numbered 1-bit is in
 397  * the first element of the values array, the next 1-bit is in the next array
 398  * element, and so on.
 399  *
 400  * MINI_N_INLINE is the default number of inline words.  When a miniflow is
 401  * dynamically allocated the actual amount of inline storage may be different.
 402  * In that case 'inline_values' contains storage at least for the number
 403  * of words indicated by 'map' (one uint32_t for each 1-bit in the map).
 404  *
 405  * Elements in values array are allowed to be zero.  This is useful for "struct
 406  * minimatch", for which ensuring that the miniflow and minimask members have
 407  * same 'map' allows optimization.  This allowance applies only to a miniflow
 408  * that is not a mask.  That is, a minimask may NOT have zero elements in
 409  * its 'values'.
 410  */
 411 struct miniflow {
 412     uint64_t map:63;
 413     uint64_t values_inline:1;
 414     union {
 415         uint32_t *offline_values;
 416         uint32_t inline_values[MINI_N_INLINE]; /* Minimum inline size. */
 417     };
 418 };
 419 BUILD_ASSERT_DECL(sizeof(struct miniflow)
 420                   == sizeof(uint64_t) + MINI_N_INLINE * sizeof(uint32_t));
 421
 422 #define MINIFLOW_VALUES_SIZE(COUNT) ((COUNT) * sizeof(uint32_t))
 423
 424 static inline uint32_t *miniflow_values(struct miniflow *mf)
 425 {
 426     return OVS_LIKELY(mf->values_inline)
 427         ? mf->inline_values : mf->offline_values;
 428 }
 429
 430 static inline const uint32_t *miniflow_get_values(const struct miniflow *mf)
 431 {
 432     return OVS_LIKELY(mf->values_inline)
 433         ? mf->inline_values : mf->offline_values;
 434 }
 435
 436 static inline const uint32_t *miniflow_get_u32_values(const struct miniflow *mf)
 437 {
 438     return miniflow_get_values(mf);
 439 }
 440
 441 static inline const ovs_be32 *miniflow_get_be32_values(const struct miniflow *mf)
 442 {
 443     return (OVS_FORCE const ovs_be32 *)miniflow_get_values(mf);
 444 }
 445
 446 /* This is useful for initializing a miniflow for a miniflow_extract() call. */
 447 static inline void miniflow_initialize(struct miniflow *mf,
 448                                        uint32_t buf[FLOW_U32S])
 449 {
 450     mf->map = 0;
 451     mf->values_inline = (buf == (uint32_t *)(mf + 1));
 452     if (!mf->values_inline) {
 453         mf->offline_values = buf;
 454     }
 455 }
 456
 457 struct pkt_metadata;
 458
 459 /* The 'dst->values' must be initialized with a buffer with space for
 460  * FLOW_U32S.  'dst->map' is ignored on input and set on output to
 461  * indicate which fields were extracted. */
 462 void miniflow_extract(struct ofpbuf *packet, const struct pkt_metadata *,
 463                       struct miniflow *dst);
 464 void miniflow_init(struct miniflow *, const struct flow *);
 465 void miniflow_init_with_minimask(struct miniflow *, const struct flow *,
 466                                  const struct minimask *);
 467 void miniflow_clone(struct miniflow *, const struct miniflow *);
 468 void miniflow_clone_inline(struct miniflow *, const struct miniflow *,
 469                            size_t n_values);
 470 void miniflow_move(struct miniflow *dst, struct miniflow *);
 471 void miniflow_destroy(struct miniflow *);
 472
 473 void miniflow_expand(const struct miniflow *, struct flow *);
 474
 475 static inline uint32_t flow_u32_value(const struct flow *flow, size_t index)
 476 {
 477     return ((uint32_t *)(flow))[index];
 478 }
 479
 480 static inline uint32_t *flow_u32_lvalue(struct flow *flow, size_t index)
 481 {
 482     return &((uint32_t *)(flow))[index];
 483 }
 484
 485 static inline bool
 486 flow_get_next_in_map(const struct flow *flow, uint64_t map, uint32_t *value)
 487 {
 488     if (map) {
 489         *value = flow_u32_value(flow, raw_ctz(map));
 490         return true;
 491     }
 492     return false;
 493 }
 494
 495 /* Iterate through all flow u32 values specified by 'MAP'. */
 496 #define FLOW_FOR_EACH_IN_MAP(VALUE, FLOW, MAP)         \
 497     for (uint64_t map__ = (MAP);                       \
 498          flow_get_next_in_map(FLOW, map__, &(VALUE));  \
 499          map__ = zero_rightmost_1bit(map__))
 500
 501 /* Iterate through all struct flow u32 indices specified by 'MAP'. */
 502 #define MAP_FOR_EACH_INDEX(U32IDX, MAP)                 \
 503     for (uint64_t map__ = (MAP);                        \
 504          map__ && ((U32IDX) = raw_ctz(map__), true);    \
 505          map__ = zero_rightmost_1bit(map__))
 506
 507 #define FLOW_U32_SIZE(FIELD)                                            \
 508     DIV_ROUND_UP(sizeof(((struct flow *)0)->FIELD), sizeof(uint32_t))
 509
 510 #define MINIFLOW_MAP(FIELD)                       \
 511     (((UINT64_C(1) << FLOW_U32_SIZE(FIELD)) - 1)  \
 512      << (offsetof(struct flow, FIELD) / 4))
 513
 514 struct mf_for_each_in_map_aux {
 515     const uint32_t *values;
 516     uint64_t fmap;
 517     uint64_t map;
 518 };
 519
 520 static inline bool
 521 mf_get_next_in_map(struct mf_for_each_in_map_aux *aux, uint32_t *value)
 522 {
 523     if (aux->map) {
 524         uint64_t rm1bit = rightmost_1bit(aux->map);
 525         aux->map -= rm1bit;
 526
 527         if (aux->fmap & rm1bit) {
 528             /* Advance 'aux->values' to point to the value for 'rm1bit'. */
 529             uint64_t trash = aux->fmap & (rm1bit - 1);
 530             if (trash) {
 531                 aux->fmap -= trash;
 532                 aux->values += count_1bits(trash);
 533             }
 534
 535             /* Retrieve the value for 'rm1bit' then advance past it. */
 536             aux->fmap -= rm1bit;
 537             *value = *aux->values++;
 538         } else {
 539             *value = 0;
 540         }
 541         return true;
 542     } else {
 543         return false;
 544     }
 545 }
 546
 547 /* Iterate through all miniflow u32 values specified by 'MAP'. */
 548 #define MINIFLOW_FOR_EACH_IN_MAP(VALUE, FLOW, MAP)                      \
 549     for (struct mf_for_each_in_map_aux aux__                            \
 550              = { miniflow_get_u32_values(FLOW), (FLOW)->map, MAP };     \
 551          mf_get_next_in_map(&aux__, &(VALUE));                          \
 552         )
 553
 554 /* Get the value of 'FIELD' of an up to 4 byte wide integer type 'TYPE' of
 555  * a miniflow. */
 556 #define MINIFLOW_GET_TYPE(MF, TYPE, OFS)                                \
 557     (((MF)->map & (UINT64_C(1) << (OFS) / 4))                           \
 558      ? ((OVS_FORCE const TYPE *)                                        \
 559         (miniflow_get_u32_values(MF)                                    \
 560          + count_1bits((MF)->map & ((UINT64_C(1) << (OFS) / 4) - 1))))  \
 561        [(OFS) % 4 / sizeof(TYPE)]                                       \
 562      : 0)                                                               \
 563
 564 #define MINIFLOW_GET_U8(FLOW, FIELD)                                    \
 565     MINIFLOW_GET_TYPE(FLOW, uint8_t, offsetof(struct flow, FIELD))
 566 #define MINIFLOW_GET_U16(FLOW, FIELD)                                    \
 567     MINIFLOW_GET_TYPE(FLOW, uint16_t, offsetof(struct flow, FIELD))
 568 #define MINIFLOW_GET_BE16(FLOW, FIELD)                                    \
 569     MINIFLOW_GET_TYPE(FLOW, ovs_be16, offsetof(struct flow, FIELD))
 570 #define MINIFLOW_GET_U32(FLOW, FIELD)                                    \
 571     MINIFLOW_GET_TYPE(FLOW, uint32_t, offsetof(struct flow, FIELD))
 572 #define MINIFLOW_GET_BE32(FLOW, FIELD)                                    \
 573     MINIFLOW_GET_TYPE(FLOW, ovs_be32, offsetof(struct flow, FIELD))
 574
 575 static inline uint16_t miniflow_get_vid(const struct miniflow *);
 576 static inline uint16_t miniflow_get_tcp_flags(const struct miniflow *);
 577 static inline ovs_be64 miniflow_get_metadata(const struct miniflow *);
 578
 579 bool miniflow_equal(const struct miniflow *a, const struct miniflow *b);
 580 bool miniflow_equal_in_minimask(const struct miniflow *a,
 581                                 const struct miniflow *b,
 582                                 const struct minimask *);
 583 bool miniflow_equal_flow_in_minimask(const struct miniflow *a,
 584                                      const struct flow *b,
 585                                      const struct minimask *);
 586 uint32_t miniflow_hash_5tuple(const struct miniflow *flow, uint32_t basis);
 587
 588 \f
 589 /* Compressed flow wildcards. */
 590
 591 /* A sparse representation of a "struct flow_wildcards".
 592  *
 593  * See the large comment on struct miniflow for details.
 594  *
 595  * Note: While miniflow can have zero data for a 1-bit in the map,
 596  * a minimask may not!  We rely on this in the implementation. */
 597 struct minimask {
 598     struct miniflow masks;
 599 };
 600
 601 void minimask_init(struct minimask *, const struct flow_wildcards *);
 602 void minimask_clone(struct minimask *, const struct minimask *);
 603 void minimask_move(struct minimask *dst, struct minimask *src);
 604 void minimask_combine(struct minimask *dst,
 605                       const struct minimask *a, const struct minimask *b,
 606                       uint32_t storage[FLOW_U32S]);
 607 void minimask_destroy(struct minimask *);
 608
 609 void minimask_expand(const struct minimask *, struct flow_wildcards *);
 610
 611 uint32_t minimask_get(const struct minimask *, unsigned int u32_ofs);
 612 static inline uint16_t minimask_get_vid_mask(const struct minimask *);
 613 static inline ovs_be64 minimask_get_metadata_mask(const struct minimask *);
 614
 615 bool minimask_equal(const struct minimask *a, const struct minimask *b);
 616 bool minimask_has_extra(const struct minimask *, const struct minimask *);
 617
 618 \f
 619 /* Returns true if 'mask' matches every packet, false if 'mask' fixes any bits
 620  * or fields. */
 621 static inline bool
 622 minimask_is_catchall(const struct minimask *mask)
 623 {
 624     /* For every 1-bit in mask's map, the corresponding value is non-zero,
 625      * so the only way the mask can not fix any bits or fields is for the
 626      * map the be zero. */
 627     return mask->masks.map == 0;
 628 }
 629
 630 /* Returns the VID within the vlan_tci member of the "struct flow" represented
 631  * by 'flow'. */
 632 static inline uint16_t
 633 miniflow_get_vid(const struct miniflow *flow)
 634 {
 635     ovs_be16 tci = MINIFLOW_GET_BE16(flow, vlan_tci);
 636     return vlan_tci_to_vid(tci);
 637 }
 638
 639 /* Returns the VID mask within the vlan_tci member of the "struct
 640  * flow_wildcards" represented by 'mask'. */
 641 static inline uint16_t
 642 minimask_get_vid_mask(const struct minimask *mask)
 643 {
 644     return miniflow_get_vid(&mask->masks);
 645 }
 646
 647 /* Returns the value of the "tcp_flags" field in 'flow'. */
 648 static inline uint16_t
 649 miniflow_get_tcp_flags(const struct miniflow *flow)
 650 {
 651     return ntohs(MINIFLOW_GET_BE16(flow, tcp_flags));
 652 }
 653
 654 /* Returns the value of the OpenFlow 1.1+ "metadata" field in 'flow'. */
 655 static inline ovs_be64
 656 miniflow_get_metadata(const struct miniflow *flow)
 657 {
 658     union {
 659         ovs_be64 be64;
 660         struct {
 661             ovs_be32 hi;
 662             ovs_be32 lo;
 663         };
 664     } value;
 665
 666     enum { MD_OFS = offsetof(struct flow, metadata) };
 667     BUILD_ASSERT_DECL(MD_OFS % sizeof(uint32_t) == 0);
 668     value.hi = MINIFLOW_GET_TYPE(flow, ovs_be32, MD_OFS);
 669     value.lo = MINIFLOW_GET_TYPE(flow, ovs_be32, MD_OFS + 4);
 670
 671     return value.be64;
 672 }
 673
 674 /* Returns the mask for the OpenFlow 1.1+ "metadata" field in 'mask'.
 675  *
 676  * The return value is all-1-bits if 'mask' matches on the whole value of the
 677  * metadata field, all-0-bits if 'mask' entirely wildcards the metadata field,
 678  * or some other value if the metadata field is partially matched, partially
 679  * wildcarded. */
 680 static inline ovs_be64
 681 minimask_get_metadata_mask(const struct minimask *mask)
 682 {
 683     return miniflow_get_metadata(&mask->masks);
 684 }
 685
 686 /* Perform a bitwise OR of miniflow 'src' flow data with the equivalent
 687  * fields in 'dst', storing the result in 'dst'. */
 688 static inline void
 689 flow_union_with_miniflow(struct flow *dst, const struct miniflow *src)
 690 {
 691     uint32_t *dst_u32 = (uint32_t *) dst;
 692     const uint32_t *p = miniflow_get_u32_values(src);
 693     uint64_t map;
 694
 695     for (map = src->map; map; map = zero_rightmost_1bit(map)) {
 696         dst_u32[raw_ctz(map)] |= *p++;
 697     }
 698 }
 699
 700 static inline struct pkt_metadata
 701 pkt_metadata_from_flow(const struct flow *flow)
 702 {
 703     struct pkt_metadata md;
 704
 705     md.recirc_id = flow->recirc_id;
 706     md.dp_hash = flow->dp_hash;
 707     md.tunnel = flow->tunnel;
 708     md.skb_priority = flow->skb_priority;
 709     md.pkt_mark = flow->pkt_mark;
 710     md.in_port = flow->in_port;
 711
 712     return md;
 713 }
 714
 715 static inline bool is_ip_any(const struct flow *flow)
 716 {
 717     return dl_type_is_ip_any(flow->dl_type);
 718 }
 719
 720 static inline bool is_icmpv4(const struct flow *flow)
 721 {
 722     return (flow->dl_type == htons(ETH_TYPE_IP)
 723             && flow->nw_proto == IPPROTO_ICMP);
 724 }
 725
 726 static inline bool is_icmpv6(const struct flow *flow)
 727 {
 728     return (flow->dl_type == htons(ETH_TYPE_IPV6)
 729             && flow->nw_proto == IPPROTO_ICMPV6);
 730 }
 731
 732 static inline bool is_stp(const struct flow *flow)
 733 {
 734     return (eth_addr_equals(flow->dl_dst, eth_addr_stp)
 735             && flow->dl_type == htons(FLOW_DL_TYPE_NONE));
 736 }
 737
 738 #endif /* flow.h */