lib/flow.h

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