lib/flow.h

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