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