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