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