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