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 "bitmap.h"
  25 #include "byte-order.h"
  26 #include "openflow/nicira-ext.h"
  27 #include "openflow/openflow.h"
  28 #include "packets.h"
  29 #include "hash.h"
  30 #include "util.h"
  31
  32 struct dpif_flow_stats;
  33 struct ds;
  34 struct flow_wildcards;
  35 struct minimask;
  36 struct dp_packet;
  37 struct pkt_metadata;
  38 struct match;
  39
  40 /* This sequence number should be incremented whenever anything involving flows
  41  * or the wildcarding of flows changes.  This will cause build assertion
  42  * failures in places which likely need to be updated. */
  43 #define FLOW_WC_SEQ 34
  44
  45 /* Number of Open vSwitch extension 32-bit registers. */
  46 #define FLOW_N_REGS 8
  47 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
  48 BUILD_ASSERT_DECL(FLOW_N_REGS % 2 == 0); /* Even. */
  49
  50 /* Number of OpenFlow 1.5+ 64-bit registers.
  51  *
  52  * Each of these overlays a pair of Open vSwitch 32-bit registers, so there
  53  * are half as many of them.*/
  54 #define FLOW_N_XREGS (FLOW_N_REGS / 2)
  55
  56 /* Used for struct flow's dl_type member for frames that have no Ethernet
  57  * type, that is, pure 802.2 frames. */
  58 #define FLOW_DL_TYPE_NONE 0x5ff
  59
  60 /* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */
  61 #define FLOW_NW_FRAG_ANY   (1 << 0) /* Set for any IP frag. */
  62 #define FLOW_NW_FRAG_LATER (1 << 1) /* Set for IP frag with nonzero offset. */
  63 #define FLOW_NW_FRAG_MASK  (FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER)
  64
  65 BUILD_ASSERT_DECL(FLOW_NW_FRAG_ANY == NX_IP_FRAG_ANY);
  66 BUILD_ASSERT_DECL(FLOW_NW_FRAG_LATER == NX_IP_FRAG_LATER);
  67
  68 BUILD_ASSERT_DECL(FLOW_TNL_F_OAM == NX_TUN_FLAG_OAM);
  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-netlink, dpif-netdev), it is
  85  * instead 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     /* Metadata */
  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 dp_hash;           /* Datapath computed hash value. The exact
 102                                  * computation is opaque to the user space. */
 103     union flow_in_port in_port; /* Input port.*/
 104     uint32_t recirc_id;         /* Must be exact match. */
 105     uint16_t ct_state;          /* Connection tracking state. */
 106     uint16_t ct_zone;           /* Connection tracking zone. */
 107     uint32_t ct_mark;           /* Connection mark.*/
 108     uint8_t pad1[4];            /* Pad to 64 bits. */
 109     uint32_t conj_id;           /* Conjunction ID. */
 110     ofp_port_t actset_output;   /* Output port in action set. */
 111     uint8_t pad2[2];            /* Pad to 64 bits. */
 112
 113     /* L2, Order the same as in the Ethernet header! (64-bit aligned) */
 114     struct eth_addr dl_dst;     /* Ethernet destination address. */
 115     struct eth_addr dl_src;     /* 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     struct eth_addr arp_sha;    /* ARP/ND source hardware address. */
 132     struct eth_addr arp_tha;    /* ARP/ND target hardware address. */
 133     ovs_be16 tcp_flags;         /* TCP flags. With L3 to avoid matching L4. */
 134     ovs_be16 pad3;              /* 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 BUILD_ASSERT_DECL(sizeof(struct flow_tnl) % sizeof(uint64_t) == 0);
 144
 145 #define FLOW_U64S (sizeof(struct flow) / sizeof(uint64_t))
 146
 147 /* Some flow fields are mutually exclusive or only appear within the flow
 148  * pipeline.  IPv6 headers are bigger than IPv4 and MPLS, and IPv6 ND packets
 149  * are bigger than TCP,UDP and IGMP packets. */
 150 #define FLOW_MAX_PACKET_U64S (FLOW_U64S                                   \
 151     /* Unused in datapath */  - FLOW_U64_SIZE(regs)                       \
 152                               - FLOW_U64_SIZE(metadata)                   \
 153     /* L2.5/3 */              - FLOW_U64_SIZE(nw_src)  /* incl. nw_dst */ \
 154                               - FLOW_U64_SIZE(mpls_lse)                   \
 155     /* L4 */                  - FLOW_U64_SIZE(tp_src)                     \
 156                              )
 157
 158 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
 159 BUILD_ASSERT_DECL(offsetof(struct flow, igmp_group_ip4) + sizeof(uint32_t)
 160                   == sizeof(struct flow_tnl) + 200
 161                   && FLOW_WC_SEQ == 34);
 162
 163 /* Incremental points at which flow classification may be performed in
 164  * segments.
 165  * This is located here since this is dependent on the structure of the
 166  * struct flow defined above:
 167  * Each offset must be on a distinct, successive U64 boundary strictly
 168  * within the struct flow. */
 169 enum {
 170     FLOW_SEGMENT_1_ENDS_AT = offsetof(struct flow, dl_dst),
 171     FLOW_SEGMENT_2_ENDS_AT = offsetof(struct flow, nw_src),
 172     FLOW_SEGMENT_3_ENDS_AT = offsetof(struct flow, tp_src),
 173 };
 174 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT % sizeof(uint64_t) == 0);
 175 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT % sizeof(uint64_t) == 0);
 176 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT % sizeof(uint64_t) == 0);
 177 BUILD_ASSERT_DECL(                     0 < FLOW_SEGMENT_1_ENDS_AT);
 178 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT < FLOW_SEGMENT_2_ENDS_AT);
 179 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT < FLOW_SEGMENT_3_ENDS_AT);
 180 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT < sizeof(struct flow));
 181
 182 extern const uint8_t flow_segment_u64s[];
 183
 184 #define FLOW_U64_OFFSET(FIELD)                          \
 185     (offsetof(struct flow, FIELD) / sizeof(uint64_t))
 186 #define FLOW_U64_OFFREM(FIELD)                          \
 187     (offsetof(struct flow, FIELD) % sizeof(uint64_t))
 188
 189 /* Number of 64-bit units spanned by a 'FIELD'. */
 190 #define FLOW_U64_SIZE(FIELD)                                            \
 191     DIV_ROUND_UP(FLOW_U64_OFFREM(FIELD) + MEMBER_SIZEOF(struct flow, FIELD), \
 192                  sizeof(uint64_t))
 193
 194 void flow_extract(struct dp_packet *, struct flow *);
 195
 196 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
 197 void flow_unwildcard_tp_ports(const struct flow *, struct flow_wildcards *);
 198 void flow_get_metadata(const struct flow *, struct match *flow_metadata);
 199
 200 const char *ct_state_to_string(uint32_t state);
 201 char *flow_to_string(const struct flow *);
 202 void format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
 203                   uint32_t flags, char del);
 204 void format_flags_masked(struct ds *ds, const char *name,
 205                          const char *(*bit_to_string)(uint32_t),
 206                          uint32_t flags, uint32_t mask, uint32_t max_mask);
 207 int parse_flags(const char *s, const char *(*bit_to_string)(uint32_t),
 208                 char end, const char *field_name, char **res_string,
 209                 uint32_t *res_flags, uint32_t allowed, uint32_t *res_mask);
 210
 211 void flow_format(struct ds *, const struct flow *);
 212 void flow_print(FILE *, const struct flow *);
 213 static inline int flow_compare_3way(const struct flow *, const struct flow *);
 214 static inline bool flow_equal(const struct flow *, const struct flow *);
 215 static inline size_t flow_hash(const struct flow *, uint32_t basis);
 216
 217 void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
 218 void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
 219 void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
 220
 221 int flow_count_mpls_labels(const struct flow *, struct flow_wildcards *);
 222 int flow_count_common_mpls_labels(const struct flow *a, int an,
 223                                   const struct flow *b, int bn,
 224                                   struct flow_wildcards *wc);
 225 void flow_push_mpls(struct flow *, int n, ovs_be16 mpls_eth_type,
 226                     struct flow_wildcards *);
 227 bool flow_pop_mpls(struct flow *, int n, ovs_be16 eth_type,
 228                    struct flow_wildcards *);
 229 void flow_set_mpls_label(struct flow *, int idx, ovs_be32 label);
 230 void flow_set_mpls_ttl(struct flow *, int idx, uint8_t ttl);
 231 void flow_set_mpls_tc(struct flow *, int idx, uint8_t tc);
 232 void flow_set_mpls_bos(struct flow *, int idx, uint8_t stack);
 233 void flow_set_mpls_lse(struct flow *, int idx, ovs_be32 lse);
 234
 235 void flow_compose(struct dp_packet *, const struct flow *);
 236
 237 static inline uint64_t
 238 flow_get_xreg(const struct flow *flow, int idx)
 239 {
 240     return ((uint64_t) flow->regs[idx * 2] << 32) | flow->regs[idx * 2 + 1];
 241 }
 242
 243 static inline void
 244 flow_set_xreg(struct flow *flow, int idx, uint64_t value)
 245 {
 246     flow->regs[idx * 2] = value >> 32;
 247     flow->regs[idx * 2 + 1] = value;
 248 }
 249
 250 static inline int
 251 flow_compare_3way(const struct flow *a, const struct flow *b)
 252 {
 253     return memcmp(a, b, sizeof *a);
 254 }
 255
 256 static inline bool
 257 flow_equal(const struct flow *a, const struct flow *b)
 258 {
 259     return !flow_compare_3way(a, b);
 260 }
 261
 262 static inline size_t
 263 flow_hash(const struct flow *flow, uint32_t basis)
 264 {
 265     return hash_words64((const uint64_t *)flow,
 266                         sizeof *flow / sizeof(uint64_t), basis);
 267 }
 268
 269 static inline uint16_t
 270 ofp_to_u16(ofp_port_t ofp_port)
 271 {
 272     return (OVS_FORCE uint16_t) ofp_port;
 273 }
 274
 275 static inline uint32_t
 276 odp_to_u32(odp_port_t odp_port)
 277 {
 278     return (OVS_FORCE uint32_t) odp_port;
 279 }
 280
 281 static inline uint32_t
 282 ofp11_to_u32(ofp11_port_t ofp11_port)
 283 {
 284     return (OVS_FORCE uint32_t) ofp11_port;
 285 }
 286
 287 static inline ofp_port_t
 288 u16_to_ofp(uint16_t port)
 289 {
 290     return OFP_PORT_C(port);
 291 }
 292
 293 static inline odp_port_t
 294 u32_to_odp(uint32_t port)
 295 {
 296     return ODP_PORT_C(port);
 297 }
 298
 299 static inline ofp11_port_t
 300 u32_to_ofp11(uint32_t port)
 301 {
 302     return OFP11_PORT_C(port);
 303 }
 304
 305 static inline uint32_t
 306 hash_ofp_port(ofp_port_t ofp_port)
 307 {
 308     return hash_int(ofp_to_u16(ofp_port), 0);
 309 }
 310
 311 static inline uint32_t
 312 hash_odp_port(odp_port_t odp_port)
 313 {
 314     return hash_int(odp_to_u32(odp_port), 0);
 315 }
 316 \f
 317 /* Wildcards for a flow.
 318  *
 319  * A 1-bit in each bit in 'masks' indicates that the corresponding bit of
 320  * the flow is significant (must match).  A 0-bit indicates that the
 321  * corresponding bit of the flow is wildcarded (need not match). */
 322 struct flow_wildcards {
 323     struct flow masks;
 324 };
 325
 326 #define WC_MASK_FIELD(WC, FIELD) \
 327     memset(&(WC)->masks.FIELD, 0xff, sizeof (WC)->masks.FIELD)
 328 #define WC_MASK_FIELD_MASK(WC, FIELD, MASK)     \
 329     ((WC)->masks.FIELD |= (MASK))
 330 #define WC_UNMASK_FIELD(WC, FIELD) \
 331     memset(&(WC)->masks.FIELD, 0, sizeof (WC)->masks.FIELD)
 332
 333 void flow_wildcards_init_catchall(struct flow_wildcards *);
 334
 335 void flow_wildcards_init_for_packet(struct flow_wildcards *,
 336                                     const struct flow *);
 337
 338 void flow_wildcards_clear_non_packet_fields(struct flow_wildcards *);
 339
 340 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
 341
 342 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
 343                                  int idx, uint32_t mask);
 344 void flow_wildcards_set_xreg_mask(struct flow_wildcards *,
 345                                   int idx, uint64_t mask);
 346
 347 void flow_wildcards_and(struct flow_wildcards *dst,
 348                         const struct flow_wildcards *src1,
 349                         const struct flow_wildcards *src2);
 350 void flow_wildcards_or(struct flow_wildcards *dst,
 351                        const struct flow_wildcards *src1,
 352                        const struct flow_wildcards *src2);
 353 bool flow_wildcards_has_extra(const struct flow_wildcards *,
 354                               const struct flow_wildcards *);
 355 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
 356 bool flow_wildcards_equal(const struct flow_wildcards *,
 357                           const struct flow_wildcards *);
 358 uint32_t flow_hash_5tuple(const struct flow *flow, uint32_t basis);
 359 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
 360 uint32_t flow_hash_symmetric_l3l4(const struct flow *flow, uint32_t basis,
 361                          bool inc_udp_ports );
 362
 363 /* Initialize a flow with random fields that matter for nx_hash_fields. */
 364 void flow_random_hash_fields(struct flow *);
 365 void flow_mask_hash_fields(const struct flow *, struct flow_wildcards *,
 366                            enum nx_hash_fields);
 367 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
 368                           uint16_t basis);
 369 const char *flow_hash_fields_to_str(enum nx_hash_fields);
 370 bool flow_hash_fields_valid(enum nx_hash_fields);
 371
 372 uint32_t flow_hash_in_wildcards(const struct flow *,
 373                                 const struct flow_wildcards *,
 374                                 uint32_t basis);
 375
 376 bool flow_equal_except(const struct flow *a, const struct flow *b,
 377                        const struct flow_wildcards *);
 378 \f
 379 /* Bitmap for flow values.  For each 1-bit the corresponding flow value is
 380  * explicitly specified, other values are zeroes.
 381  *
 382  * map_t must be wide enough to hold any member of struct flow. */
 383 typedef unsigned long long map_t;
 384 #define MAP_T_BITS (sizeof(map_t) * CHAR_BIT)
 385 #define MAP_1 (map_t)1
 386 #define MAP_MAX TYPE_MAXIMUM(map_t)
 387
 388 #define MAP_IS_SET(MAP, IDX) ((MAP) & (MAP_1 << (IDX)))
 389
 390 /* Iterate through the indices of all 1-bits in 'MAP'. */
 391 #define MAP_FOR_EACH_INDEX(IDX, MAP)            \
 392     ULLONG_FOR_EACH_1(IDX, MAP)
 393
 394 #define FLOWMAP_UNITS DIV_ROUND_UP(FLOW_U64S, MAP_T_BITS)
 395
 396 struct flowmap {
 397     map_t bits[FLOWMAP_UNITS];
 398 };
 399
 400 #define FLOWMAP_EMPTY_INITIALIZER { { 0 } }
 401
 402 static inline void flowmap_init(struct flowmap *);
 403 static inline bool flowmap_equal(struct flowmap, struct flowmap);
 404 static inline bool flowmap_is_set(const struct flowmap *, size_t idx);
 405 static inline bool flowmap_are_set(const struct flowmap *, size_t idx,
 406                                    unsigned int n_bits);
 407 static inline void flowmap_set(struct flowmap *, size_t idx,
 408                                unsigned int n_bits);
 409 static inline void flowmap_clear(struct flowmap *, size_t idx,
 410                                  unsigned int n_bits);
 411 static inline struct flowmap flowmap_or(struct flowmap, struct flowmap);
 412 static inline struct flowmap flowmap_and(struct flowmap, struct flowmap);
 413 static inline bool flowmap_is_empty(struct flowmap);
 414 static inline unsigned int flowmap_n_1bits(struct flowmap);
 415
 416 #define FLOWMAP_HAS_FIELD(FM, FIELD)                                    \
 417     flowmap_are_set(FM, FLOW_U64_OFFSET(FIELD), FLOW_U64_SIZE(FIELD))
 418
 419 #define FLOWMAP_SET(FM, FIELD)                                      \
 420     flowmap_set(FM, FLOW_U64_OFFSET(FIELD), FLOW_U64_SIZE(FIELD))
 421
 422 #define FLOWMAP_SET__(FM, FIELD, SIZE)                  \
 423     flowmap_set(FM, FLOW_U64_OFFSET(FIELD),             \
 424                 DIV_ROUND_UP(SIZE, sizeof(uint64_t)))
 425
 426 /* XXX: Only works for full 64-bit units. */
 427 #define FLOWMAP_CLEAR(FM, FIELD)                                        \
 428     BUILD_ASSERT_DECL(FLOW_U64_OFFREM(FIELD) == 0);                     \
 429     BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->FIELD) % sizeof(uint64_t) == 0); \
 430     flowmap_clear(FM, FLOW_U64_OFFSET(FIELD), FLOW_U64_SIZE(FIELD))
 431
 432 /* Iterate through all units in 'FMAP'. */
 433 #define FLOWMAP_FOR_EACH_UNIT(UNIT)                     \
 434     for ((UNIT) = 0; (UNIT) < FLOWMAP_UNITS; (UNIT)++)
 435
 436 /* Iterate through all map units in 'FMAP'. */
 437 #define FLOWMAP_FOR_EACH_MAP(MAP, FLOWMAP)                              \
 438     for (size_t unit__ = 0;                                       \
 439          unit__ < FLOWMAP_UNITS && ((MAP) = (FLOWMAP).bits[unit__], true); \
 440          unit__++)
 441
 442 struct flowmap_aux;
 443 static inline bool flowmap_next_index(struct flowmap_aux *, size_t *idx);
 444
 445 #define FLOWMAP_AUX_INITIALIZER(FLOWMAP) { .unit = 0, .map = (FLOWMAP) }
 446
 447 /* Iterate through all struct flow u64 indices specified by 'MAP'.  This is a
 448  * slower but easier version of the FLOWMAP_FOR_EACH_MAP() &
 449  * MAP_FOR_EACH_INDEX() combination. */
 450 #define FLOWMAP_FOR_EACH_INDEX(IDX, MAP)                            \
 451     for (struct flowmap_aux aux__ = FLOWMAP_AUX_INITIALIZER(MAP);   \
 452          flowmap_next_index(&aux__, &(IDX));)
 453
 454 /* Flowmap inline implementations. */
 455 static inline void
 456 flowmap_init(struct flowmap *fm)
 457 {
 458     memset(fm, 0, sizeof *fm);
 459 }
 460
 461 static inline bool
 462 flowmap_equal(struct flowmap a, struct flowmap b)
 463 {
 464     return !memcmp(&a, &b, sizeof a);
 465 }
 466
 467 static inline bool
 468 flowmap_is_set(const struct flowmap *fm, size_t idx)
 469 {
 470     return (fm->bits[idx / MAP_T_BITS] & (MAP_1 << (idx % MAP_T_BITS))) != 0;
 471 }
 472
 473 /* Returns 'true' if any of the 'n_bits' bits starting at 'idx' are set in
 474  * 'fm'.  'n_bits' can be at most MAP_T_BITS. */
 475 static inline bool
 476 flowmap_are_set(const struct flowmap *fm, size_t idx, unsigned int n_bits)
 477 {
 478     map_t n_bits_mask = (MAP_1 << n_bits) - 1;
 479     size_t unit = idx / MAP_T_BITS;
 480
 481     idx %= MAP_T_BITS;
 482
 483     if (fm->bits[unit] & (n_bits_mask << idx)) {
 484         return true;
 485     }
 486     /* The seemingly unnecessary bounds check on 'unit' is a workaround for a
 487      * false-positive array out of bounds error by GCC 4.9. */
 488     if (unit + 1 < FLOWMAP_UNITS && idx + n_bits > MAP_T_BITS) {
 489         /* Check the remaining bits from the next unit. */
 490         return fm->bits[unit + 1] & (n_bits_mask >> (MAP_T_BITS - idx));
 491     }
 492     return false;
 493 }
 494
 495 /* Set the 'n_bits' consecutive bits in 'fm', starting at bit 'idx'.
 496  * 'n_bits' can be at most MAP_T_BITS. */
 497 static inline void
 498 flowmap_set(struct flowmap *fm, size_t idx, unsigned int n_bits)
 499 {
 500     map_t n_bits_mask = (MAP_1 << n_bits) - 1;
 501     size_t unit = idx / MAP_T_BITS;
 502
 503     idx %= MAP_T_BITS;
 504
 505     fm->bits[unit] |= n_bits_mask << idx;
 506     /* The seemingly unnecessary bounds check on 'unit' is a workaround for a
 507      * false-positive array out of bounds error by GCC 4.9. */
 508     if (unit + 1 < FLOWMAP_UNITS && idx + n_bits > MAP_T_BITS) {
 509         /* 'MAP_T_BITS - idx' bits were set on 'unit', set the remaining
 510          * bits from the next unit. */
 511         fm->bits[unit + 1] |= n_bits_mask >> (MAP_T_BITS - idx);
 512     }
 513 }
 514
 515 /* Clears the 'n_bits' consecutive bits in 'fm', starting at bit 'idx'.
 516  * 'n_bits' can be at most MAP_T_BITS. */
 517 static inline void
 518 flowmap_clear(struct flowmap *fm, size_t idx, unsigned int n_bits)
 519 {
 520     map_t n_bits_mask = (MAP_1 << n_bits) - 1;
 521     size_t unit = idx / MAP_T_BITS;
 522
 523     idx %= MAP_T_BITS;
 524
 525     fm->bits[unit] &= ~(n_bits_mask << idx);
 526     /* The seemingly unnecessary bounds check on 'unit' is a workaround for a
 527      * false-positive array out of bounds error by GCC 4.9. */
 528     if (unit + 1 < FLOWMAP_UNITS && idx + n_bits > MAP_T_BITS) {
 529         /* 'MAP_T_BITS - idx' bits were cleared on 'unit', clear the
 530          * remaining bits from the next unit. */
 531         fm->bits[unit + 1] &= ~(n_bits_mask >> (MAP_T_BITS - idx));
 532     }
 533 }
 534
 535 /* OR the bits in the flowmaps. */
 536 static inline struct flowmap
 537 flowmap_or(struct flowmap a, struct flowmap b)
 538 {
 539     struct flowmap map;
 540     size_t unit;
 541
 542     FLOWMAP_FOR_EACH_UNIT (unit) {
 543         map.bits[unit] = a.bits[unit] | b.bits[unit];
 544     }
 545     return map;
 546 }
 547
 548 /* AND the bits in the flowmaps. */
 549 static inline struct flowmap
 550 flowmap_and(struct flowmap a, struct flowmap b)
 551 {
 552     struct flowmap map;
 553     size_t unit;
 554
 555     FLOWMAP_FOR_EACH_UNIT (unit) {
 556         map.bits[unit] = a.bits[unit] & b.bits[unit];
 557     }
 558     return map;
 559 }
 560
 561 static inline bool
 562 flowmap_is_empty(struct flowmap fm)
 563 {
 564     map_t map;
 565
 566     FLOWMAP_FOR_EACH_MAP (map, fm) {
 567         if (map) {
 568             return false;
 569         }
 570     }
 571     return true;
 572 }
 573
 574 static inline unsigned int
 575 flowmap_n_1bits(struct flowmap fm)
 576 {
 577     unsigned int n_1bits = 0;
 578     size_t unit;
 579
 580     FLOWMAP_FOR_EACH_UNIT (unit) {
 581         n_1bits += count_1bits(fm.bits[unit]);
 582     }
 583     return n_1bits;
 584 }
 585
 586 struct flowmap_aux {
 587     size_t unit;
 588     struct flowmap map;
 589 };
 590
 591 static inline bool
 592 flowmap_next_index(struct flowmap_aux *aux, size_t *idx)
 593 {
 594     for (;;) {
 595         map_t *map = &aux->map.bits[aux->unit];
 596         if (*map) {
 597             *idx = aux->unit * MAP_T_BITS + raw_ctz(*map);
 598             *map = zero_rightmost_1bit(*map);
 599             return true;
 600         }
 601         if (++aux->unit >= FLOWMAP_UNITS) {
 602             return false;
 603         }
 604     }
 605 }
 606
 607 \f
 608 /* Compressed flow. */
 609
 610 /* A sparse representation of a "struct flow".
 611  *
 612  * A "struct flow" is fairly large and tends to be mostly zeros.  Sparse
 613  * representation has two advantages.  First, it saves memory and, more
 614  * importantly, minimizes the number of accessed cache lines.  Second, it saves
 615  * time when the goal is to iterate over only the nonzero parts of the struct.
 616  *
 617  * The map member hold one bit for each uint64_t in a "struct flow".  Each
 618  * 0-bit indicates that the corresponding uint64_t is zero, each 1-bit that it
 619  * *may* be nonzero (see below how this applies to minimasks).
 620  *
 621  * The values indicated by 'map' always follow the miniflow in memory.  The
 622  * user of the miniflow is responsible for always having enough storage after
 623  * the struct miniflow corresponding to the number of 1-bits in maps.
 624  *
 625  * Elements in values array are allowed to be zero.  This is useful for "struct
 626  * minimatch", for which ensuring that the miniflow and minimask members have
 627  * same maps allows optimization.  This allowance applies only to a miniflow
 628  * that is not a mask.  That is, a minimask may NOT have zero elements in its
 629  * values.
 630  *
 631  * A miniflow is always dynamically allocated so that the maps are followed by
 632  * at least as many elements as there are 1-bits in maps. */
 633 struct miniflow {
 634     struct flowmap map;
 635     /* Followed by:
 636      *     uint64_t values[n];
 637      * where 'n' is miniflow_n_values(miniflow). */
 638 };
 639 BUILD_ASSERT_DECL(sizeof(struct miniflow) % sizeof(uint64_t) == 0);
 640
 641 #define MINIFLOW_VALUES_SIZE(COUNT) ((COUNT) * sizeof(uint64_t))
 642
 643 static inline uint64_t *miniflow_values(struct miniflow *mf)
 644 {
 645     return (uint64_t *)(mf + 1);
 646 }
 647
 648 static inline const uint64_t *miniflow_get_values(const struct miniflow *mf)
 649 {
 650     return (const uint64_t *)(mf + 1);
 651 }
 652
 653 struct pkt_metadata;
 654
 655 /* The 'dst' must follow with buffer space for FLOW_U64S 64-bit units.
 656  * 'dst->map' is ignored on input and set on output to indicate which fields
 657  * were extracted. */
 658 void miniflow_extract(struct dp_packet *packet, struct miniflow *dst);
 659 void miniflow_map_init(struct miniflow *, const struct flow *);
 660 void flow_wc_map(const struct flow *, struct flowmap *);
 661 size_t miniflow_alloc(struct miniflow *dsts[], size_t n,
 662                       const struct miniflow *src);
 663 void miniflow_init(struct miniflow *, const struct flow *);
 664 void miniflow_clone(struct miniflow *, const struct miniflow *,
 665                     size_t n_values);
 666 struct miniflow * miniflow_create(const struct flow *);
 667
 668 void miniflow_expand(const struct miniflow *, struct flow *);
 669
 670 static inline uint64_t flow_u64_value(const struct flow *flow, size_t index)
 671 {
 672     return ((uint64_t *)flow)[index];
 673 }
 674
 675 static inline uint64_t *flow_u64_lvalue(struct flow *flow, size_t index)
 676 {
 677     return &((uint64_t *)flow)[index];
 678 }
 679
 680 static inline size_t
 681 miniflow_n_values(const struct miniflow *flow)
 682 {
 683     return flowmap_n_1bits(flow->map);
 684 }
 685
 686 struct flow_for_each_in_maps_aux {
 687     const struct flow *flow;
 688     struct flowmap_aux map_aux;
 689 };
 690
 691 static inline bool
 692 flow_values_get_next_in_maps(struct flow_for_each_in_maps_aux *aux,
 693                              uint64_t *value)
 694 {
 695     size_t idx;
 696
 697     if (flowmap_next_index(&aux->map_aux, &idx)) {
 698         *value = flow_u64_value(aux->flow, idx);
 699         return true;
 700     }
 701     return false;
 702 }
 703
 704 /* Iterate through all flow u64 values specified by 'MAPS'. */
 705 #define FLOW_FOR_EACH_IN_MAPS(VALUE, FLOW, MAPS)            \
 706     for (struct flow_for_each_in_maps_aux aux__             \
 707              = { (FLOW), FLOWMAP_AUX_INITIALIZER(MAPS) };   \
 708          flow_values_get_next_in_maps(&aux__, &(VALUE));)
 709
 710 struct mf_for_each_in_map_aux {
 711     size_t unit;
 712     struct flowmap fmap;
 713     struct flowmap map;
 714     const uint64_t *values;
 715 };
 716
 717 static inline bool
 718 mf_get_next_in_map(struct mf_for_each_in_map_aux *aux,
 719                    uint64_t *value)
 720 {
 721     map_t *map, *fmap;
 722     map_t rm1bit;
 723
 724     while (OVS_UNLIKELY(!*(map = &aux->map.bits[aux->unit]))) {
 725         /* Skip remaining data in the previous unit. */
 726         aux->values += count_1bits(aux->fmap.bits[aux->unit]);
 727         if (++aux->unit == FLOWMAP_UNITS) {
 728             return false;
 729         }
 730     }
 731
 732     rm1bit = rightmost_1bit(*map);
 733     *map -= rm1bit;
 734     fmap = &aux->fmap.bits[aux->unit];
 735
 736     if (OVS_LIKELY(*fmap & rm1bit)) {
 737         map_t trash = *fmap & (rm1bit - 1);
 738
 739         *fmap -= trash;
 740         /* count_1bits() is fast for systems where speed matters (e.g.,
 741          * DPDK), so we don't try avoid using it.
 742          * Advance 'aux->values' to point to the value for 'rm1bit'. */
 743         aux->values += count_1bits(trash);
 744
 745         *value = *aux->values;
 746     } else {
 747         *value = 0;
 748     }
 749     return true;
 750 }
 751
 752 /* Iterate through miniflow u64 values specified by 'FLOWMAP'. */
 753 #define MINIFLOW_FOR_EACH_IN_FLOWMAP(VALUE, FLOW, FLOWMAP)          \
 754     for (struct mf_for_each_in_map_aux aux__ =                      \
 755         { 0, (FLOW)->map, (FLOWMAP), miniflow_get_values(FLOW) };   \
 756          mf_get_next_in_map(&aux__, &(VALUE));)
 757
 758 /* This can be used when it is known that 'idx' is set in 'map'. */
 759 static inline const uint64_t *
 760 miniflow_values_get__(const uint64_t *values, map_t map, size_t idx)
 761 {
 762     return values + count_1bits(map & ((MAP_1 << idx) - 1));
 763 }
 764
 765 /* This can be used when it is known that 'u64_idx' is set in
 766  * the map of 'mf'. */
 767 static inline const uint64_t *
 768 miniflow_get__(const struct miniflow *mf, size_t idx)
 769 {
 770     const uint64_t *values = miniflow_get_values(mf);
 771     const map_t *map = mf->map.bits;
 772
 773     while (idx >= MAP_T_BITS) {
 774         idx -= MAP_T_BITS;
 775         values += count_1bits(*map++);
 776     }
 777     return miniflow_values_get__(values, *map, idx);
 778 }
 779
 780 #define MINIFLOW_IN_MAP(MF, IDX) flowmap_is_set(&(MF)->map, IDX)
 781
 782 /* Get the value of the struct flow 'FIELD' as up to 8 byte wide integer type
 783  * 'TYPE' from miniflow 'MF'. */
 784 #define MINIFLOW_GET_TYPE(MF, TYPE, FIELD)                              \
 785     (MINIFLOW_IN_MAP(MF, FLOW_U64_OFFSET(FIELD))                        \
 786      ? ((OVS_FORCE const TYPE *)miniflow_get__(MF, FLOW_U64_OFFSET(FIELD))) \
 787      [FLOW_U64_OFFREM(FIELD) / sizeof(TYPE)]                            \
 788      : 0)
 789
 790 #define MINIFLOW_GET_U8(FLOW, FIELD)            \
 791     MINIFLOW_GET_TYPE(FLOW, uint8_t, FIELD)
 792 #define MINIFLOW_GET_U16(FLOW, FIELD)           \
 793     MINIFLOW_GET_TYPE(FLOW, uint16_t, FIELD)
 794 #define MINIFLOW_GET_BE16(FLOW, FIELD)          \
 795     MINIFLOW_GET_TYPE(FLOW, ovs_be16, FIELD)
 796 #define MINIFLOW_GET_U32(FLOW, FIELD)           \
 797     MINIFLOW_GET_TYPE(FLOW, uint32_t, FIELD)
 798 #define MINIFLOW_GET_BE32(FLOW, FIELD)          \
 799     MINIFLOW_GET_TYPE(FLOW, ovs_be32, FIELD)
 800 #define MINIFLOW_GET_U64(FLOW, FIELD)           \
 801     MINIFLOW_GET_TYPE(FLOW, uint64_t, FIELD)
 802 #define MINIFLOW_GET_BE64(FLOW, FIELD)          \
 803     MINIFLOW_GET_TYPE(FLOW, ovs_be64, FIELD)
 804
 805 static inline uint64_t miniflow_get(const struct miniflow *,
 806                                     unsigned int u64_ofs);
 807 static inline uint32_t miniflow_get_u32(const struct miniflow *,
 808                                         unsigned int u32_ofs);
 809 static inline ovs_be32 miniflow_get_be32(const struct miniflow *,
 810                                          unsigned int be32_ofs);
 811 static inline uint16_t miniflow_get_vid(const struct miniflow *);
 812 static inline uint16_t miniflow_get_tcp_flags(const struct miniflow *);
 813 static inline ovs_be64 miniflow_get_metadata(const struct miniflow *);
 814
 815 bool miniflow_equal(const struct miniflow *a, const struct miniflow *b);
 816 bool miniflow_equal_in_minimask(const struct miniflow *a,
 817                                 const struct miniflow *b,
 818                                 const struct minimask *);
 819 bool miniflow_equal_flow_in_minimask(const struct miniflow *a,
 820                                      const struct flow *b,
 821                                      const struct minimask *);
 822 uint32_t miniflow_hash_5tuple(const struct miniflow *flow, uint32_t basis);
 823
 824 \f
 825 /* Compressed flow wildcards. */
 826
 827 /* A sparse representation of a "struct flow_wildcards".
 828  *
 829  * See the large comment on struct miniflow for details.
 830  *
 831  * Note: While miniflow can have zero data for a 1-bit in the map,
 832  * a minimask may not!  We rely on this in the implementation. */
 833 struct minimask {
 834     struct miniflow masks;
 835 };
 836
 837 void minimask_init(struct minimask *, const struct flow_wildcards *);
 838 struct minimask * minimask_create(const struct flow_wildcards *);
 839 void minimask_combine(struct minimask *dst,
 840                       const struct minimask *a, const struct minimask *b,
 841                       uint64_t storage[FLOW_U64S]);
 842
 843 void minimask_expand(const struct minimask *, struct flow_wildcards *);
 844
 845 static inline uint32_t minimask_get_u32(const struct minimask *,
 846                                         unsigned int u32_ofs);
 847 static inline ovs_be32 minimask_get_be32(const struct minimask *,
 848                                          unsigned int be32_ofs);
 849 static inline uint16_t minimask_get_vid_mask(const struct minimask *);
 850 static inline ovs_be64 minimask_get_metadata_mask(const struct minimask *);
 851
 852 bool minimask_equal(const struct minimask *a, const struct minimask *b);
 853 bool minimask_has_extra(const struct minimask *, const struct minimask *);
 854
 855 \f
 856 /* Returns true if 'mask' matches every packet, false if 'mask' fixes any bits
 857  * or fields. */
 858 static inline bool
 859 minimask_is_catchall(const struct minimask *mask)
 860 {
 861     /* For every 1-bit in mask's map, the corresponding value is non-zero,
 862      * so the only way the mask can not fix any bits or fields is for the
 863      * map the be zero. */
 864     return flowmap_is_empty(mask->masks.map);
 865 }
 866
 867 /* Returns the uint64_t that would be at byte offset '8 * u64_ofs' if 'flow'
 868  * were expanded into a "struct flow". */
 869 static inline uint64_t miniflow_get(const struct miniflow *flow,
 870                                     unsigned int u64_ofs)
 871 {
 872     return MINIFLOW_IN_MAP(flow, u64_ofs) ? *miniflow_get__(flow, u64_ofs) : 0;
 873 }
 874
 875 static inline uint32_t miniflow_get_u32(const struct miniflow *flow,
 876                                         unsigned int u32_ofs)
 877 {
 878     uint64_t value = miniflow_get(flow, u32_ofs / 2);
 879
 880 #if WORDS_BIGENDIAN
 881     return (u32_ofs & 1) ? value : value >> 32;
 882 #else
 883     return (u32_ofs & 1) ? value >> 32 : value;
 884 #endif
 885 }
 886
 887 static inline ovs_be32 miniflow_get_be32(const struct miniflow *flow,
 888                                          unsigned int be32_ofs)
 889 {
 890     return (OVS_FORCE ovs_be32)miniflow_get_u32(flow, be32_ofs);
 891 }
 892
 893 /* Returns the VID within the vlan_tci member of the "struct flow" represented
 894  * by 'flow'. */
 895 static inline uint16_t
 896 miniflow_get_vid(const struct miniflow *flow)
 897 {
 898     ovs_be16 tci = MINIFLOW_GET_BE16(flow, vlan_tci);
 899     return vlan_tci_to_vid(tci);
 900 }
 901
 902 /* Returns the uint32_t that would be at byte offset '4 * u32_ofs' if 'mask'
 903  * were expanded into a "struct flow_wildcards". */
 904 static inline uint32_t
 905 minimask_get_u32(const struct minimask *mask, unsigned int u32_ofs)
 906 {
 907     return miniflow_get_u32(&mask->masks, u32_ofs);
 908 }
 909
 910 static inline ovs_be32
 911 minimask_get_be32(const struct minimask *mask, unsigned int be32_ofs)
 912 {
 913     return (OVS_FORCE ovs_be32)minimask_get_u32(mask, be32_ofs);
 914 }
 915
 916 /* Returns the VID mask within the vlan_tci member of the "struct
 917  * flow_wildcards" represented by 'mask'. */
 918 static inline uint16_t
 919 minimask_get_vid_mask(const struct minimask *mask)
 920 {
 921     return miniflow_get_vid(&mask->masks);
 922 }
 923
 924 /* Returns the value of the "tcp_flags" field in 'flow'. */
 925 static inline uint16_t
 926 miniflow_get_tcp_flags(const struct miniflow *flow)
 927 {
 928     return ntohs(MINIFLOW_GET_BE16(flow, tcp_flags));
 929 }
 930
 931 /* Returns the value of the OpenFlow 1.1+ "metadata" field in 'flow'. */
 932 static inline ovs_be64
 933 miniflow_get_metadata(const struct miniflow *flow)
 934 {
 935     return MINIFLOW_GET_BE64(flow, metadata);
 936 }
 937
 938 /* Returns the mask for the OpenFlow 1.1+ "metadata" field in 'mask'.
 939  *
 940  * The return value is all-1-bits if 'mask' matches on the whole value of the
 941  * metadata field, all-0-bits if 'mask' entirely wildcards the metadata field,
 942  * or some other value if the metadata field is partially matched, partially
 943  * wildcarded. */
 944 static inline ovs_be64
 945 minimask_get_metadata_mask(const struct minimask *mask)
 946 {
 947     return MINIFLOW_GET_BE64(&mask->masks, metadata);
 948 }
 949
 950 /* Perform a bitwise OR of miniflow 'src' flow data specified in 'subset' with
 951  * the equivalent fields in 'dst', storing the result in 'dst'.  'subset' must
 952  * be a subset of 'src's map. */
 953 static inline void
 954 flow_union_with_miniflow_subset(struct flow *dst, const struct miniflow *src,
 955                                 struct flowmap subset)
 956 {
 957     uint64_t *dst_u64 = (uint64_t *) dst;
 958     const uint64_t *p = miniflow_get_values(src);
 959     map_t map;
 960
 961     FLOWMAP_FOR_EACH_MAP (map, subset) {
 962         size_t idx;
 963
 964         MAP_FOR_EACH_INDEX(idx, map) {
 965             dst_u64[idx] |= *p++;
 966         }
 967         dst_u64 += MAP_T_BITS;
 968     }
 969 }
 970
 971 /* Perform a bitwise OR of miniflow 'src' flow data with the equivalent
 972  * fields in 'dst', storing the result in 'dst'. */
 973 static inline void
 974 flow_union_with_miniflow(struct flow *dst, const struct miniflow *src)
 975 {
 976     flow_union_with_miniflow_subset(dst, src, src->map);
 977 }
 978
 979 static inline void
 980 pkt_metadata_from_flow(struct pkt_metadata *md, const struct flow *flow)
 981 {
 982     md->recirc_id = flow->recirc_id;
 983     md->dp_hash = flow->dp_hash;
 984     flow_tnl_copy__(&md->tunnel, &flow->tunnel);
 985     md->skb_priority = flow->skb_priority;
 986     md->pkt_mark = flow->pkt_mark;
 987     md->in_port = flow->in_port;
 988     md->ct_state = flow->ct_state;
 989     md->ct_zone = flow->ct_zone;
 990     md->ct_mark = flow->ct_mark;
 991 }
 992
 993 static inline bool is_ip_any(const struct flow *flow)
 994 {
 995     return dl_type_is_ip_any(flow->dl_type);
 996 }
 997
 998 static inline bool is_icmpv4(const struct flow *flow)
 999 {
1000     return (flow->dl_type == htons(ETH_TYPE_IP)
1001             && flow->nw_proto == IPPROTO_ICMP);
1002 }
1003
1004 static inline bool is_icmpv6(const struct flow *flow)
1005 {
1006     return (flow->dl_type == htons(ETH_TYPE_IPV6)
1007             && flow->nw_proto == IPPROTO_ICMPV6);
1008 }
1009
1010 static inline bool is_igmp(const struct flow *flow)
1011 {
1012     return (flow->dl_type == htons(ETH_TYPE_IP)
1013             && flow->nw_proto == IPPROTO_IGMP);
1014 }
1015
1016 static inline bool is_mld(const struct flow *flow)
1017 {
1018     return is_icmpv6(flow)
1019            && (flow->tp_src == htons(MLD_QUERY)
1020                || flow->tp_src == htons(MLD_REPORT)
1021                || flow->tp_src == htons(MLD_DONE)
1022                || flow->tp_src == htons(MLD2_REPORT));
1023 }
1024
1025 static inline bool is_mld_query(const struct flow *flow)
1026 {
1027     return is_icmpv6(flow) && flow->tp_src == htons(MLD_QUERY);
1028 }
1029
1030 static inline bool is_mld_report(const struct flow *flow)
1031 {
1032     return is_mld(flow) && !is_mld_query(flow);
1033 }
1034
1035 static inline bool is_stp(const struct flow *flow)
1036 {
1037     return (eth_addr_equals(flow->dl_dst, eth_addr_stp)
1038             && flow->dl_type == htons(FLOW_DL_TYPE_NONE));
1039 }
1040
1041 #endif /* flow.h */