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 27
  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     /* L1 */
  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
 106     /* L2, Order the same as in the Ethernet header! */
 107     uint8_t dl_dst[6];          /* Ethernet destination address. */
 108     uint8_t dl_src[6];          /* Ethernet source address. */
 109     ovs_be16 dl_type;           /* Ethernet frame type. */
 110     ovs_be16 vlan_tci;          /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
 111     ovs_be32 mpls_lse[FLOW_MAX_MPLS_LABELS]; /* MPLS label stack entry. */
 112
 113     /* L3 */
 114     struct in6_addr ipv6_src;   /* IPv6 source address. */
 115     struct in6_addr ipv6_dst;   /* IPv6 destination address. */
 116     ovs_be32 ipv6_label;        /* IPv6 flow label. */
 117     ovs_be32 nw_src;            /* IPv4 source address. */
 118     ovs_be32 nw_dst;            /* IPv4 destination address. */
 119     uint8_t nw_frag;            /* FLOW_FRAG_* flags. */
 120     uint8_t nw_tos;             /* IP ToS (including DSCP and ECN). */
 121     uint8_t nw_ttl;             /* IP TTL/Hop Limit. */
 122     uint8_t nw_proto;           /* IP protocol or low 8 bits of ARP opcode. */
 123     uint8_t arp_sha[6];         /* ARP/ND source hardware address. */
 124     uint8_t arp_tha[6];         /* ARP/ND target hardware address. */
 125     struct in6_addr nd_target;  /* IPv6 neighbor discovery (ND) target. */
 126     ovs_be16 tcp_flags;         /* TCP flags. With L3 to avoid matching L4. */
 127     ovs_be16 pad;               /* Padding. */
 128
 129     /* L4 */
 130     ovs_be16 tp_src;            /* TCP/UDP/SCTP source port. */
 131     ovs_be16 tp_dst;            /* TCP/UDP/SCTP destination port. */
 132     ovs_be32 igmp_group_ip4;    /* IGMP group IPv4 address */
 133     uint32_t dp_hash;           /* Datapath computed hash value. The exact
 134                                  * computation is opaque to the user space.
 135                                  * Keep last for BUILD_ASSERT_DECL below. */
 136 };
 137 BUILD_ASSERT_DECL(sizeof(struct flow) % 4 == 0);
 138
 139 #define FLOW_U32S (sizeof(struct flow) / 4)
 140
 141 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
 142 BUILD_ASSERT_DECL(offsetof(struct flow, dp_hash) + sizeof(uint32_t)
 143                   == sizeof(struct flow_tnl) + 176
 144                   && FLOW_WC_SEQ == 27);
 145
 146 /* Incremental points at which flow classification may be performed in
 147  * segments.
 148  * This is located here since this is dependent on the structure of the
 149  * struct flow defined above:
 150  * Each offset must be on a distinct, successive U32 boundary strictly
 151  * within the struct flow. */
 152 enum {
 153     FLOW_SEGMENT_1_ENDS_AT = offsetof(struct flow, dl_dst),
 154     FLOW_SEGMENT_2_ENDS_AT = offsetof(struct flow, ipv6_src),
 155     FLOW_SEGMENT_3_ENDS_AT = offsetof(struct flow, tp_src),
 156 };
 157 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT % 4 == 0);
 158 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT % 4 == 0);
 159 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT % 4 == 0);
 160 BUILD_ASSERT_DECL(                     0 < FLOW_SEGMENT_1_ENDS_AT);
 161 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT < FLOW_SEGMENT_2_ENDS_AT);
 162 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT < FLOW_SEGMENT_3_ENDS_AT);
 163 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT < sizeof(struct flow));
 164
 165 extern const uint8_t flow_segment_u32s[];
 166
 167 /* Represents the metadata fields of struct flow. */
 168 struct flow_metadata {
 169     uint32_t dp_hash;                /* Datapath computed hash field. */
 170     uint32_t recirc_id;              /* Recirculation ID. */
 171     ovs_be64 tun_id;                 /* Encapsulating tunnel ID. */
 172     ovs_be32 tun_src;                /* Tunnel outer IPv4 src addr */
 173     ovs_be32 tun_dst;                /* Tunnel outer IPv4 dst addr */
 174     ovs_be64 metadata;               /* OpenFlow 1.1+ metadata field. */
 175     uint32_t regs[FLOW_N_REGS];      /* Registers. */
 176     uint32_t pkt_mark;               /* Packet mark. */
 177     ofp_port_t in_port;              /* OpenFlow port or zero. */
 178 };
 179
 180 void flow_extract(struct ofpbuf *, const struct pkt_metadata *md,
 181                   struct flow *);
 182
 183 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
 184 void flow_unwildcard_tp_ports(const struct flow *, struct flow_wildcards *);
 185 void flow_get_metadata(const struct flow *, struct flow_metadata *);
 186
 187 char *flow_to_string(const struct flow *);
 188 void format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
 189                   uint32_t flags, char del);
 190 void format_flags_masked(struct ds *ds, const char *name,
 191                          const char *(*bit_to_string)(uint32_t),
 192                          uint32_t flags, uint32_t mask);
 193
 194 void flow_format(struct ds *, const struct flow *);
 195 void flow_print(FILE *, const struct flow *);
 196 static inline int flow_compare_3way(const struct flow *, const struct flow *);
 197 static inline bool flow_equal(const struct flow *, const struct flow *);
 198 static inline size_t flow_hash(const struct flow *, uint32_t basis);
 199
 200 void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
 201 void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
 202 void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
 203
 204 int flow_count_mpls_labels(const struct flow *, struct flow_wildcards *);
 205 int flow_count_common_mpls_labels(const struct flow *a, int an,
 206                                   const struct flow *b, int bn,
 207                                   struct flow_wildcards *wc);
 208 void flow_push_mpls(struct flow *, int n, ovs_be16 mpls_eth_type,
 209                     struct flow_wildcards *);
 210 bool flow_pop_mpls(struct flow *, int n, ovs_be16 eth_type,
 211                    struct flow_wildcards *);
 212 void flow_set_mpls_label(struct flow *, int idx, ovs_be32 label);
 213 void flow_set_mpls_ttl(struct flow *, int idx, uint8_t ttl);
 214 void flow_set_mpls_tc(struct flow *, int idx, uint8_t tc);
 215 void flow_set_mpls_bos(struct flow *, int idx, uint8_t stack);
 216 void flow_set_mpls_lse(struct flow *, int idx, ovs_be32 lse);
 217
 218 void flow_compose(struct ofpbuf *, const struct flow *);
 219
 220 static inline uint64_t
 221 flow_get_xreg(const struct flow *flow, int idx)
 222 {
 223     return ((uint64_t) flow->regs[idx * 2] << 32) | flow->regs[idx * 2 + 1];
 224 }
 225
 226 static inline void
 227 flow_set_xreg(struct flow *flow, int idx, uint64_t value)
 228 {
 229     flow->regs[idx * 2] = value >> 32;
 230     flow->regs[idx * 2 + 1] = value;
 231 }
 232
 233 static inline int
 234 flow_compare_3way(const struct flow *a, const struct flow *b)
 235 {
 236     return memcmp(a, b, sizeof *a);
 237 }
 238
 239 static inline bool
 240 flow_equal(const struct flow *a, const struct flow *b)
 241 {
 242     return !flow_compare_3way(a, b);
 243 }
 244
 245 static inline size_t
 246 flow_hash(const struct flow *flow, uint32_t basis)
 247 {
 248     return hash_words((const uint32_t *) flow, sizeof *flow / 4, basis);
 249 }
 250
 251 static inline uint16_t
 252 ofp_to_u16(ofp_port_t ofp_port)
 253 {
 254     return (OVS_FORCE uint16_t) ofp_port;
 255 }
 256
 257 static inline uint32_t
 258 odp_to_u32(odp_port_t odp_port)
 259 {
 260     return (OVS_FORCE uint32_t) odp_port;
 261 }
 262
 263 static inline uint32_t
 264 ofp11_to_u32(ofp11_port_t ofp11_port)
 265 {
 266     return (OVS_FORCE uint32_t) ofp11_port;
 267 }
 268
 269 static inline ofp_port_t
 270 u16_to_ofp(uint16_t port)
 271 {
 272     return OFP_PORT_C(port);
 273 }
 274
 275 static inline odp_port_t
 276 u32_to_odp(uint32_t port)
 277 {
 278     return ODP_PORT_C(port);
 279 }
 280
 281 static inline ofp11_port_t
 282 u32_to_ofp11(uint32_t port)
 283 {
 284     return OFP11_PORT_C(port);
 285 }
 286
 287 static inline uint32_t
 288 hash_ofp_port(ofp_port_t ofp_port)
 289 {
 290     return hash_int(ofp_to_u16(ofp_port), 0);
 291 }
 292
 293 static inline uint32_t
 294 hash_odp_port(odp_port_t odp_port)
 295 {
 296     return hash_int(odp_to_u32(odp_port), 0);
 297 }
 298 \f
 299 /* Wildcards for a flow.
 300  *
 301  * A 1-bit in each bit in 'masks' indicates that the corresponding bit of
 302  * the flow is significant (must match).  A 0-bit indicates that the
 303  * corresponding bit of the flow is wildcarded (need not match). */
 304 struct flow_wildcards {
 305     struct flow masks;
 306 };
 307
 308 #define WC_MASK_FIELD(WC, FIELD) \
 309     memset(&(WC)->masks.FIELD, 0xff, sizeof (WC)->masks.FIELD)
 310 #define WC_UNMASK_FIELD(WC, FIELD) \
 311     memset(&(WC)->masks.FIELD, 0, sizeof (WC)->masks.FIELD)
 312
 313 void flow_wildcards_init_catchall(struct flow_wildcards *);
 314
 315 void flow_wildcards_init_for_packet(struct flow_wildcards *,
 316                                     const struct flow *);
 317
 318 void flow_wildcards_clear_non_packet_fields(struct flow_wildcards *);
 319
 320 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
 321
 322 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
 323                                  int idx, uint32_t mask);
 324 void flow_wildcards_set_xreg_mask(struct flow_wildcards *,
 325                                   int idx, uint64_t mask);
 326
 327 void flow_wildcards_and(struct flow_wildcards *dst,
 328                         const struct flow_wildcards *src1,
 329                         const struct flow_wildcards *src2);
 330 void flow_wildcards_or(struct flow_wildcards *dst,
 331                        const struct flow_wildcards *src1,
 332                        const struct flow_wildcards *src2);
 333 bool flow_wildcards_has_extra(const struct flow_wildcards *,
 334                               const struct flow_wildcards *);
 335 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
 336 bool flow_wildcards_equal(const struct flow_wildcards *,
 337                           const struct flow_wildcards *);
 338 uint32_t flow_hash_5tuple(const struct flow *flow, uint32_t basis);
 339 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
 340
 341 /* Initialize a flow with random fields that matter for nx_hash_fields. */
 342 void flow_random_hash_fields(struct flow *);
 343 void flow_mask_hash_fields(const struct flow *, struct flow_wildcards *,
 344                            enum nx_hash_fields);
 345 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
 346                           uint16_t basis);
 347 const char *flow_hash_fields_to_str(enum nx_hash_fields);
 348 bool flow_hash_fields_valid(enum nx_hash_fields);
 349
 350 uint32_t flow_hash_in_wildcards(const struct flow *,
 351                                 const struct flow_wildcards *,
 352                                 uint32_t basis);
 353
 354 bool flow_equal_except(const struct flow *a, const struct flow *b,
 355                        const struct flow_wildcards *);
 356 \f
 357 /* Compressed flow. */
 358
 359 /* Number of 32-bit words present in struct miniflow. */
 360 #define MINI_N_INLINE 8
 361
 362 /* Maximum number of 32-bit words supported. */
 363 BUILD_ASSERT_DECL(FLOW_U32S <= 63);
 364
 365 /* A sparse representation of a "struct flow".
 366  *
 367  * A "struct flow" is fairly large and tends to be mostly zeros.  Sparse
 368  * representation has two advantages.  First, it saves memory.  Second, it
 369  * saves time when the goal is to iterate over only the nonzero parts of the
 370  * struct.
 371  *
 372  * The 'map' member holds one bit for each uint32_t in a "struct flow".  Each
 373  * 0-bit indicates that the corresponding uint32_t is zero, each 1-bit that it
 374  * *may* be nonzero (see below how this applies to minimasks).
 375  *
 376  * The 'values_inline' boolean member indicates that the values are at
 377  * 'inline_values'.  If 'values_inline' is zero, then the values are
 378  * offline at 'offline_values'.  In either case, values is an array that has
 379  * one element for each 1-bit in 'map'.  The least-numbered 1-bit is in
 380  * the first element of the values array, the next 1-bit is in the next array
 381  * element, and so on.
 382  *
 383  * MINI_N_INLINE is the default number of inline words.  When a miniflow is
 384  * dynamically allocated the actual amount of inline storage may be different.
 385  * In that case 'inline_values' contains storage at least for the number
 386  * of words indicated by 'map' (one uint32_t for each 1-bit in the map).
 387  *
 388  * Elements in values array are allowed to be zero.  This is useful for "struct
 389  * minimatch", for which ensuring that the miniflow and minimask members have
 390  * same 'map' allows optimization.  This allowance applies only to a miniflow
 391  * that is not a mask.  That is, a minimask may NOT have zero elements in
 392  * its 'values'.
 393  */
 394 struct miniflow {
 395     uint64_t map:63;
 396     uint64_t values_inline:1;
 397     union {
 398         uint32_t *offline_values;
 399         uint32_t inline_values[MINI_N_INLINE]; /* Minimum inline size. */
 400     };
 401 };
 402 BUILD_ASSERT_DECL(sizeof(struct miniflow)
 403                   == sizeof(uint64_t) + MINI_N_INLINE * sizeof(uint32_t));
 404
 405 #define MINIFLOW_VALUES_SIZE(COUNT) ((COUNT) * sizeof(uint32_t))
 406
 407 static inline uint32_t *miniflow_values(struct miniflow *mf)
 408 {
 409     return OVS_LIKELY(mf->values_inline)
 410         ? mf->inline_values : mf->offline_values;
 411 }
 412
 413 static inline const uint32_t *miniflow_get_values(const struct miniflow *mf)
 414 {
 415     return OVS_LIKELY(mf->values_inline)
 416         ? mf->inline_values : mf->offline_values;
 417 }
 418
 419 static inline const uint32_t *miniflow_get_u32_values(const struct miniflow *mf)
 420 {
 421     return miniflow_get_values(mf);
 422 }
 423
 424 static inline const ovs_be32 *miniflow_get_be32_values(const struct miniflow *mf)
 425 {
 426     return (OVS_FORCE const ovs_be32 *)miniflow_get_values(mf);
 427 }
 428
 429 /* This is useful for initializing a miniflow for a miniflow_extract() call. */
 430 static inline void miniflow_initialize(struct miniflow *mf,
 431                                        uint32_t buf[FLOW_U32S])
 432 {
 433     mf->map = 0;
 434     mf->values_inline = (buf == (uint32_t *)(mf + 1));
 435     if (!mf->values_inline) {
 436         mf->offline_values = buf;
 437     }
 438 }
 439
 440 struct pkt_metadata;
 441
 442 /* The 'dst->values' must be initialized with a buffer with space for
 443  * FLOW_U32S.  'dst->map' is ignored on input and set on output to
 444  * indicate which fields were extracted. */
 445 void miniflow_extract(struct ofpbuf *packet, const struct pkt_metadata *,
 446                       struct miniflow *dst);
 447 void miniflow_init(struct miniflow *, const struct flow *);
 448 void miniflow_init_with_minimask(struct miniflow *, const struct flow *,
 449                                  const struct minimask *);
 450 void miniflow_clone(struct miniflow *, const struct miniflow *);
 451 void miniflow_clone_inline(struct miniflow *, const struct miniflow *,
 452                            size_t n_values);
 453 void miniflow_move(struct miniflow *dst, struct miniflow *);
 454 void miniflow_destroy(struct miniflow *);
 455
 456 void miniflow_expand(const struct miniflow *, struct flow *);
 457
 458 static inline uint32_t flow_u32_value(const struct flow *flow, size_t index)
 459 {
 460     return ((uint32_t *)(flow))[index];
 461 }
 462
 463 static inline uint32_t *flow_u32_lvalue(struct flow *flow, size_t index)
 464 {
 465     return &((uint32_t *)(flow))[index];
 466 }
 467
 468 static inline bool
 469 flow_get_next_in_map(const struct flow *flow, uint64_t map, uint32_t *value)
 470 {
 471     if (map) {
 472         *value = flow_u32_value(flow, raw_ctz(map));
 473         return true;
 474     }
 475     return false;
 476 }
 477
 478 /* Iterate through all flow u32 values specified by 'MAP'. */
 479 #define FLOW_FOR_EACH_IN_MAP(VALUE, FLOW, MAP)         \
 480     for (uint64_t map__ = (MAP);                       \
 481          flow_get_next_in_map(FLOW, map__, &(VALUE));  \
 482          map__ = zero_rightmost_1bit(map__))
 483
 484 /* Iterate through all struct flow u32 indices specified by 'MAP'. */
 485 #define MAP_FOR_EACH_INDEX(U32IDX, MAP)         \
 486     for (uint64_t map__ = (MAP);                \
 487          ((U32IDX) = ctz64(map__)) < FLOW_U32S; \
 488          map__ = zero_rightmost_1bit(map__))
 489
 490 #define FLOW_U32_SIZE(FIELD)                                            \
 491     DIV_ROUND_UP(sizeof(((struct flow *)0)->FIELD), sizeof(uint32_t))
 492
 493 #define MINIFLOW_MAP(FIELD)                       \
 494     (((UINT64_C(1) << FLOW_U32_SIZE(FIELD)) - 1)  \
 495      << (offsetof(struct flow, FIELD) / 4))
 496
 497 static inline uint32_t
 498 mf_get_next_in_map(uint64_t *fmap, uint64_t rm1bit, const uint32_t **fp,
 499                    uint32_t *value)
 500 {
 501     *value = 0;
 502     if (*fmap & rm1bit) {
 503         uint64_t trash = *fmap & (rm1bit - 1);
 504
 505         if (trash) {
 506             *fmap -= trash;
 507             *fp += count_1bits(trash);
 508         }
 509         *value = **fp;
 510     }
 511     return rm1bit != 0;
 512 }
 513
 514 /* Iterate through all miniflow u32 values specified by 'MAP'.
 515  * This works as the first statement in a block.*/
 516 #define MINIFLOW_FOR_EACH_IN_MAP(VALUE, FLOW, MAP)                      \
 517     const uint32_t *fp_ = miniflow_get_u32_values(FLOW);                \
 518     uint64_t rm1bit_, fmap_, map_;                                      \
 519     for (fmap_ = (FLOW)->map, map_ = (MAP), rm1bit_ = rightmost_1bit(map_); \
 520          mf_get_next_in_map(&fmap_, rm1bit_, &fp_, &(VALUE));           \
 521          map_ -= rm1bit_, rm1bit_ = rightmost_1bit(map_))
 522
 523 /* Get the value of 'FIELD' of an up to 4 byte wide integer type 'TYPE' of
 524  * a miniflow. */
 525 #define MINIFLOW_GET_TYPE(MF, TYPE, OFS)                                \
 526     (((MF)->map & (UINT64_C(1) << (OFS) / 4))                           \
 527      ? ((OVS_FORCE const TYPE *)                                        \
 528         (miniflow_get_u32_values(MF)                                    \
 529          + count_1bits((MF)->map & ((UINT64_C(1) << (OFS) / 4) - 1))))  \
 530        [(OFS) % 4 / sizeof(TYPE)]                                       \
 531      : 0)                                                               \
 532
 533 #define MINIFLOW_GET_U8(FLOW, FIELD)                                    \
 534     MINIFLOW_GET_TYPE(FLOW, uint8_t, offsetof(struct flow, FIELD))
 535 #define MINIFLOW_GET_U16(FLOW, FIELD)                                    \
 536     MINIFLOW_GET_TYPE(FLOW, uint16_t, offsetof(struct flow, FIELD))
 537 #define MINIFLOW_GET_BE16(FLOW, FIELD)                                    \
 538     MINIFLOW_GET_TYPE(FLOW, ovs_be16, offsetof(struct flow, FIELD))
 539 #define MINIFLOW_GET_U32(FLOW, FIELD)                                    \
 540     MINIFLOW_GET_TYPE(FLOW, uint32_t, offsetof(struct flow, FIELD))
 541 #define MINIFLOW_GET_BE32(FLOW, FIELD)                                    \
 542     MINIFLOW_GET_TYPE(FLOW, ovs_be32, offsetof(struct flow, FIELD))
 543
 544 static inline uint16_t miniflow_get_vid(const struct miniflow *);
 545 static inline uint16_t miniflow_get_tcp_flags(const struct miniflow *);
 546 static inline ovs_be64 miniflow_get_metadata(const struct miniflow *);
 547
 548 bool miniflow_equal(const struct miniflow *a, const struct miniflow *b);
 549 bool miniflow_equal_in_minimask(const struct miniflow *a,
 550                                 const struct miniflow *b,
 551                                 const struct minimask *);
 552 bool miniflow_equal_flow_in_minimask(const struct miniflow *a,
 553                                      const struct flow *b,
 554                                      const struct minimask *);
 555 uint32_t miniflow_hash_5tuple(const struct miniflow *flow, uint32_t basis);
 556
 557 \f
 558 /* Compressed flow wildcards. */
 559
 560 /* A sparse representation of a "struct flow_wildcards".
 561  *
 562  * See the large comment on struct miniflow for details.
 563  *
 564  * Note: While miniflow can have zero data for a 1-bit in the map,
 565  * a minimask may not!  We rely on this in the implementation. */
 566 struct minimask {
 567     struct miniflow masks;
 568 };
 569
 570 void minimask_init(struct minimask *, const struct flow_wildcards *);
 571 void minimask_clone(struct minimask *, const struct minimask *);
 572 void minimask_move(struct minimask *dst, struct minimask *src);
 573 void minimask_combine(struct minimask *dst,
 574                       const struct minimask *a, const struct minimask *b,
 575                       uint32_t storage[FLOW_U32S]);
 576 void minimask_destroy(struct minimask *);
 577
 578 void minimask_expand(const struct minimask *, struct flow_wildcards *);
 579
 580 uint32_t minimask_get(const struct minimask *, unsigned int u32_ofs);
 581 static inline uint16_t minimask_get_vid_mask(const struct minimask *);
 582 static inline ovs_be64 minimask_get_metadata_mask(const struct minimask *);
 583
 584 bool minimask_equal(const struct minimask *a, const struct minimask *b);
 585 bool minimask_has_extra(const struct minimask *, const struct minimask *);
 586
 587 \f
 588 /* Returns true if 'mask' matches every packet, false if 'mask' fixes any bits
 589  * or fields. */
 590 static inline bool
 591 minimask_is_catchall(const struct minimask *mask)
 592 {
 593     /* For every 1-bit in mask's map, the corresponding value is non-zero,
 594      * so the only way the mask can not fix any bits or fields is for the
 595      * map the be zero. */
 596     return mask->masks.map == 0;
 597 }
 598
 599 /* Returns the VID within the vlan_tci member of the "struct flow" represented
 600  * by 'flow'. */
 601 static inline uint16_t
 602 miniflow_get_vid(const struct miniflow *flow)
 603 {
 604     ovs_be16 tci = MINIFLOW_GET_BE16(flow, vlan_tci);
 605     return vlan_tci_to_vid(tci);
 606 }
 607
 608 /* Returns the VID mask within the vlan_tci member of the "struct
 609  * flow_wildcards" represented by 'mask'. */
 610 static inline uint16_t
 611 minimask_get_vid_mask(const struct minimask *mask)
 612 {
 613     return miniflow_get_vid(&mask->masks);
 614 }
 615
 616 /* Returns the value of the "tcp_flags" field in 'flow'. */
 617 static inline uint16_t
 618 miniflow_get_tcp_flags(const struct miniflow *flow)
 619 {
 620     return ntohs(MINIFLOW_GET_BE16(flow, tcp_flags));
 621 }
 622
 623 /* Returns the value of the OpenFlow 1.1+ "metadata" field in 'flow'. */
 624 static inline ovs_be64
 625 miniflow_get_metadata(const struct miniflow *flow)
 626 {
 627     union {
 628         ovs_be64 be64;
 629         struct {
 630             ovs_be32 hi;
 631             ovs_be32 lo;
 632         };
 633     } value;
 634
 635     enum { MD_OFS = offsetof(struct flow, metadata) };
 636     BUILD_ASSERT_DECL(MD_OFS % sizeof(uint32_t) == 0);
 637     value.hi = MINIFLOW_GET_TYPE(flow, ovs_be32, MD_OFS);
 638     value.lo = MINIFLOW_GET_TYPE(flow, ovs_be32, MD_OFS + 4);
 639
 640     return value.be64;
 641 }
 642
 643 /* Returns the mask for the OpenFlow 1.1+ "metadata" field in 'mask'.
 644  *
 645  * The return value is all-1-bits if 'mask' matches on the whole value of the
 646  * metadata field, all-0-bits if 'mask' entirely wildcards the metadata field,
 647  * or some other value if the metadata field is partially matched, partially
 648  * wildcarded. */
 649 static inline ovs_be64
 650 minimask_get_metadata_mask(const struct minimask *mask)
 651 {
 652     return miniflow_get_metadata(&mask->masks);
 653 }
 654
 655 /* Perform a bitwise OR of miniflow 'src' flow data with the equivalent
 656  * fields in 'dst', storing the result in 'dst'. */
 657 static inline void
 658 flow_union_with_miniflow(struct flow *dst, const struct miniflow *src)
 659 {
 660     uint32_t *dst_u32 = (uint32_t *) dst;
 661     const uint32_t *p = miniflow_get_u32_values(src);
 662     uint64_t map;
 663
 664     for (map = src->map; map; map = zero_rightmost_1bit(map)) {
 665         dst_u32[raw_ctz(map)] |= *p++;
 666     }
 667 }
 668
 669 static inline struct pkt_metadata
 670 pkt_metadata_from_flow(const struct flow *flow)
 671 {
 672     struct pkt_metadata md;
 673
 674     md.recirc_id = flow->recirc_id;
 675     md.dp_hash = flow->dp_hash;
 676     md.tunnel = flow->tunnel;
 677     md.skb_priority = flow->skb_priority;
 678     md.pkt_mark = flow->pkt_mark;
 679     md.in_port = flow->in_port;
 680
 681     return md;
 682 }
 683
 684 static inline bool is_ip_any(const struct flow *flow)
 685 {
 686     return dl_type_is_ip_any(flow->dl_type);
 687 }
 688
 689 static inline bool is_icmpv4(const struct flow *flow)
 690 {
 691     return (flow->dl_type == htons(ETH_TYPE_IP)
 692             && flow->nw_proto == IPPROTO_ICMP);
 693 }
 694
 695 static inline bool is_icmpv6(const struct flow *flow)
 696 {
 697     return (flow->dl_type == htons(ETH_TYPE_IPV6)
 698             && flow->nw_proto == IPPROTO_ICMPV6);
 699 }
 700
 701 static inline bool is_stp(const struct flow *flow)
 702 {
 703     return (eth_addr_equals(flow->dl_dst, eth_addr_stp)
 704             && flow->dl_type == htons(FLOW_DL_TYPE_NONE));
 705 }
 706
 707 #endif /* flow.h */