lib/flow.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 #ifndef FLOW_H
  17 #define FLOW_H 1
  18
  19 #include <sys/types.h>
  20 #include <netinet/in.h>
  21 #include <stdbool.h>
  22 #include <stdint.h>
  23 #include <string.h>
  24 #include "byte-order.h"
  25 #include "openflow/nicira-ext.h"
  26 #include "openflow/openflow.h"
  27 #include "hash.h"
  28 #include "util.h"
  29
  30 struct dpif_flow_stats;
  31 struct ds;
  32 struct flow_wildcards;
  33 struct minimask;
  34 struct ofpbuf;
  35 struct pkt_metadata;
  36
  37 /* This sequence number should be incremented whenever anything involving flows
  38  * or the wildcarding of flows changes.  This will cause build assertion
  39  * failures in places which likely need to be updated. */
  40 #define FLOW_WC_SEQ 26
  41
  42 #define FLOW_N_REGS 8
  43 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
  44
  45 /* Used for struct flow's dl_type member for frames that have no Ethernet
  46  * type, that is, pure 802.2 frames. */
  47 #define FLOW_DL_TYPE_NONE 0x5ff
  48
  49 /* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */
  50 #define FLOW_NW_FRAG_ANY   (1 << 0) /* Set for any IP frag. */
  51 #define FLOW_NW_FRAG_LATER (1 << 1) /* Set for IP frag with nonzero offset. */
  52 #define FLOW_NW_FRAG_MASK  (FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER)
  53
  54 BUILD_ASSERT_DECL(FLOW_NW_FRAG_ANY == NX_IP_FRAG_ANY);
  55 BUILD_ASSERT_DECL(FLOW_NW_FRAG_LATER == NX_IP_FRAG_LATER);
  56
  57 #define FLOW_TNL_F_DONT_FRAGMENT (1 << 0)
  58 #define FLOW_TNL_F_CSUM (1 << 1)
  59 #define FLOW_TNL_F_KEY (1 << 2)
  60
  61 const char *flow_tun_flag_to_string(uint32_t flags);
  62
  63 struct flow_tnl {
  64     ovs_be64 tun_id;
  65     ovs_be32 ip_src;
  66     ovs_be32 ip_dst;
  67     uint16_t flags;
  68     uint8_t ip_tos;
  69     uint8_t ip_ttl;
  70 };
  71
  72 /* Unfortunately, a "struct flow" sometimes has to handle OpenFlow port
  73  * numbers and other times datapath (dpif) port numbers.  This union allows
  74  * access to both. */
  75 union flow_in_port {
  76     odp_port_t odp_port;
  77     ofp_port_t ofp_port;
  78 };
  79
  80 /* Maximum number of supported MPLS labels. */
  81 #define FLOW_MAX_MPLS_LABELS 3
  82
  83 /*
  84  * A flow in the network.
  85  *
  86  * Must be initialized to all zeros to make any compiler-induced padding
  87  * zeroed.  Helps also in keeping unused fields (such as mutually exclusive
  88  * IPv4 and IPv6 addresses) zeroed out.
  89  *
  90  * The meaning of 'in_port' is context-dependent.  In most cases, it is a
  91  * 16-bit OpenFlow 1.0 port number.  In the software datapath interface (dpif)
  92  * layer and its implementations (e.g. dpif-linux, dpif-netdev), it is instead
  93  * a 32-bit datapath port number.
  94  *
  95  * The fields are organized in four segments to facilitate staged lookup, where
  96  * lower layer fields are first used to determine if the later fields need to
  97  * be looked at.  This enables better wildcarding for datapath flows.
  98  *
  99  * NOTE: Order of the fields is significant, any change in the order must be
 100  * reflected in miniflow_extract()!
 101  */
 102 struct flow {
 103     /* L1 */
 104     struct flow_tnl tunnel;     /* Encapsulating tunnel parameters. */
 105     ovs_be64 metadata;          /* OpenFlow Metadata. */
 106     uint32_t regs[FLOW_N_REGS]; /* Registers. */
 107     uint32_t skb_priority;      /* Packet priority for QoS. */
 108     uint32_t pkt_mark;          /* Packet mark. */
 109     uint32_t recirc_id;         /* Must be exact match. */
 110     union flow_in_port in_port; /* Input port.*/
 111
 112     /* L2, Order the same as in the Ethernet header! */
 113     uint8_t dl_dst[6];          /* Ethernet destination address. */
 114     uint8_t dl_src[6];          /* 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[FLOW_MAX_MPLS_LABELS]; /* MPLS label stack entry. */
 118
 119     /* L3 */
 120     struct in6_addr ipv6_src;   /* IPv6 source address. */
 121     struct in6_addr ipv6_dst;   /* IPv6 destination address. */
 122     ovs_be32 ipv6_label;        /* IPv6 flow label. */
 123     ovs_be32 nw_src;            /* IPv4 source address. */
 124     ovs_be32 nw_dst;            /* IPv4 destination address. */
 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     uint8_t arp_sha[6];         /* ARP/ND source hardware address. */
 130     uint8_t arp_tha[6];         /* ARP/ND target hardware address. */
 131     struct in6_addr nd_target;  /* IPv6 neighbor discovery (ND) target. */
 132     ovs_be16 tcp_flags;         /* TCP flags. With L3 to avoid matching L4. */
 133     ovs_be16 pad;               /* Padding. */
 134
 135     /* L4 */
 136     ovs_be16 tp_src;            /* TCP/UDP/SCTP source port. */
 137     ovs_be16 tp_dst;            /* TCP/UDP/SCTP destination port.
 138                                  * Keep last for the BUILD_ASSERT_DECL below */
 139     uint32_t dp_hash;           /* Datapath computed hash value. The exact
 140                                    computation is opaque to the user space.*/
 141 };
 142 BUILD_ASSERT_DECL(sizeof(struct flow) % 4 == 0);
 143
 144 #define FLOW_U32S (sizeof(struct flow) / 4)
 145
 146 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
 147 BUILD_ASSERT_DECL(offsetof(struct flow, dp_hash) + sizeof(uint32_t)
 148                   == sizeof(struct flow_tnl) + 172
 149                   && FLOW_WC_SEQ == 26);
 150
 151 /* Incremental points at which flow classification may be performed in
 152  * segments.
 153  * This is located here since this is dependent on the structure of the
 154  * struct flow defined above:
 155  * Each offset must be on a distinct, successive U32 boundary strictly
 156  * within the struct flow. */
 157 enum {
 158     FLOW_SEGMENT_1_ENDS_AT = offsetof(struct flow, dl_dst),
 159     FLOW_SEGMENT_2_ENDS_AT = offsetof(struct flow, ipv6_src),
 160     FLOW_SEGMENT_3_ENDS_AT = offsetof(struct flow, tp_src),
 161 };
 162 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT % 4 == 0);
 163 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT % 4 == 0);
 164 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT % 4 == 0);
 165 BUILD_ASSERT_DECL(                     0 < FLOW_SEGMENT_1_ENDS_AT);
 166 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT < FLOW_SEGMENT_2_ENDS_AT);
 167 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT < FLOW_SEGMENT_3_ENDS_AT);
 168 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT < sizeof(struct flow));
 169
 170 extern const uint8_t flow_segment_u32s[];
 171
 172 /* Represents the metadata fields of struct flow. */
 173 struct flow_metadata {
 174     uint32_t dp_hash;                /* Datapath computed hash field. */
 175     uint32_t recirc_id;              /* Recirculation ID. */
 176     ovs_be64 tun_id;                 /* Encapsulating tunnel ID. */
 177     ovs_be32 tun_src;                /* Tunnel outer IPv4 src addr */
 178     ovs_be32 tun_dst;                /* Tunnel outer IPv4 dst addr */
 179     ovs_be64 metadata;               /* OpenFlow 1.1+ metadata field. */
 180     uint32_t regs[FLOW_N_REGS];      /* Registers. */
 181     uint32_t pkt_mark;               /* Packet mark. */
 182     ofp_port_t in_port;              /* OpenFlow port or zero. */
 183 };
 184
 185 void flow_extract(struct ofpbuf *, const struct pkt_metadata *md,
 186                   struct flow *);
 187
 188 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
 189 void flow_unwildcard_tp_ports(const struct flow *, struct flow_wildcards *);
 190 void flow_get_metadata(const struct flow *, struct flow_metadata *);
 191
 192 char *flow_to_string(const struct flow *);
 193 void format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
 194                   uint32_t flags, char del);
 195 void format_flags_masked(struct ds *ds, const char *name,
 196                          const char *(*bit_to_string)(uint32_t),
 197                          uint32_t flags, uint32_t 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 ofpbuf *, const struct flow *);
 224
 225 static inline int
 226 flow_compare_3way(const struct flow *a, const struct flow *b)
 227 {
 228     return memcmp(a, b, sizeof *a);
 229 }
 230
 231 static inline bool
 232 flow_equal(const struct flow *a, const struct flow *b)
 233 {
 234     return !flow_compare_3way(a, b);
 235 }
 236
 237 static inline size_t
 238 flow_hash(const struct flow *flow, uint32_t basis)
 239 {
 240     return hash_words((const uint32_t *) flow, sizeof *flow / 4, basis);
 241 }
 242
 243 static inline uint16_t
 244 ofp_to_u16(ofp_port_t ofp_port)
 245 {
 246     return (OVS_FORCE uint16_t) ofp_port;
 247 }
 248
 249 static inline uint32_t
 250 odp_to_u32(odp_port_t odp_port)
 251 {
 252     return (OVS_FORCE uint32_t) odp_port;
 253 }
 254
 255 static inline uint32_t
 256 ofp11_to_u32(ofp11_port_t ofp11_port)
 257 {
 258     return (OVS_FORCE uint32_t) ofp11_port;
 259 }
 260
 261 static inline ofp_port_t
 262 u16_to_ofp(uint16_t port)
 263 {
 264     return OFP_PORT_C(port);
 265 }
 266
 267 static inline odp_port_t
 268 u32_to_odp(uint32_t port)
 269 {
 270     return ODP_PORT_C(port);
 271 }
 272
 273 static inline ofp11_port_t
 274 u32_to_ofp11(uint32_t port)
 275 {
 276     return OFP11_PORT_C(port);
 277 }
 278
 279 static inline uint32_t
 280 hash_ofp_port(ofp_port_t ofp_port)
 281 {
 282     return hash_int(ofp_to_u16(ofp_port), 0);
 283 }
 284
 285 static inline uint32_t
 286 hash_odp_port(odp_port_t odp_port)
 287 {
 288     return hash_int(odp_to_u32(odp_port), 0);
 289 }
 290
 291 uint32_t flow_hash_in_minimask(const struct flow *, const struct minimask *,
 292                                uint32_t basis);
 293 uint32_t flow_hash_in_minimask_range(const struct flow *,
 294                                      const struct minimask *,
 295                                      uint8_t start, uint8_t end,
 296                                      uint32_t *basis);
 297 \f
 298 /* Wildcards for a flow.
 299  *
 300  * A 1-bit in each bit in 'masks' indicates that the corresponding bit of
 301  * the flow is significant (must match).  A 0-bit indicates that the
 302  * corresponding bit of the flow is wildcarded (need not match). */
 303 struct flow_wildcards {
 304     struct flow masks;
 305 };
 306
 307 void flow_wildcards_init_catchall(struct flow_wildcards *);
 308
 309 void flow_wildcards_clear_non_packet_fields(struct flow_wildcards *);
 310
 311 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
 312
 313 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
 314                                  int idx, uint32_t mask);
 315
 316 void flow_wildcards_and(struct flow_wildcards *dst,
 317                         const struct flow_wildcards *src1,
 318                         const struct flow_wildcards *src2);
 319 void flow_wildcards_or(struct flow_wildcards *dst,
 320                        const struct flow_wildcards *src1,
 321                        const struct flow_wildcards *src2);
 322 bool flow_wildcards_has_extra(const struct flow_wildcards *,
 323                               const struct flow_wildcards *);
 324
 325 void flow_wildcards_fold_minimask(struct flow_wildcards *,
 326                                   const struct minimask *);
 327 void flow_wildcards_fold_minimask_range(struct flow_wildcards *,
 328                                         const struct minimask *,
 329                                         uint8_t start, uint8_t end);
 330
 331 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
 332 bool flow_wildcards_equal(const struct flow_wildcards *,
 333                           const struct flow_wildcards *);
 334 uint32_t flow_hash_5tuple(const struct flow *flow, uint32_t basis);
 335 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
 336
 337 /* Initialize a flow with random fields that matter for nx_hash_fields. */
 338 void flow_random_hash_fields(struct flow *);
 339 void flow_mask_hash_fields(const struct flow *, struct flow_wildcards *,
 340                            enum nx_hash_fields);
 341 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
 342                           uint16_t basis);
 343 const char *flow_hash_fields_to_str(enum nx_hash_fields);
 344 bool flow_hash_fields_valid(enum nx_hash_fields);
 345
 346 uint32_t flow_hash_in_wildcards(const struct flow *,
 347                                 const struct flow_wildcards *,
 348                                 uint32_t basis);
 349
 350 bool flow_equal_except(const struct flow *a, const struct flow *b,
 351                        const struct flow_wildcards *);
 352 \f
 353 /* Compressed flow. */
 354
 355 #define MINI_N_INLINE (sizeof(void *) == 4 ? 7 : 8)
 356 BUILD_ASSERT_DECL(FLOW_U32S <= 64);
 357
 358 /* A sparse representation of a "struct flow".
 359  *
 360  * A "struct flow" is fairly large and tends to be mostly zeros.  Sparse
 361  * representation has two advantages.  First, it saves memory.  Second, it
 362  * saves time when the goal is to iterate over only the nonzero parts of the
 363  * struct.
 364  *
 365  * The 'map' member holds one bit for each uint32_t in a "struct flow".  Each
 366  * 0-bit indicates that the corresponding uint32_t is zero, each 1-bit that it
 367  * *may* be nonzero.
 368  *
 369  * 'values' points to the start of an array that has one element for each 1-bit
 370  * in 'map'.  The least-numbered 1-bit is in values[0], the next 1-bit is in
 371  * values[1], and so on.
 372  *
 373  * 'values' may point to a few different locations:
 374  *
 375  *     - If 'map' has MINI_N_INLINE or fewer 1-bits, it may point to
 376  *       'inline_values'.  One hopes that this is the common case.
 377  *
 378  *     - If 'map' has more than MINI_N_INLINE 1-bits, it may point to memory
 379  *       allocated with malloc().
 380  *
 381  *     - The caller could provide storage on the stack for situations where
 382  *       that makes sense.  So far that's only proved useful for
 383  *       minimask_combine(), but the principle works elsewhere.
 384  *
 385  * Elements in 'values' are allowed to be zero.  This is useful for "struct
 386  * minimatch", for which ensuring that the miniflow and minimask members have
 387  * same 'map' allows optimization.  This allowance applies only to a miniflow
 388  * that is not a mask.  That is, a minimask may NOT have zero elements in
 389  * its 'values'.
 390  */
 391 struct miniflow {
 392     uint64_t map;
 393     uint32_t *values;
 394     uint32_t inline_values[MINI_N_INLINE];
 395 };
 396
 397 /* This is useful for initializing a miniflow for a miniflow_extract() call. */
 398 static inline void miniflow_initialize(struct miniflow *mf,
 399                                        uint32_t buf[FLOW_U32S])
 400 {
 401     mf->map = 0;
 402     mf->values = buf;
 403 }
 404
 405 struct pkt_metadata;
 406
 407 /* The 'dst->values' must be initialized with a buffer with space for
 408  * FLOW_U32S.  'dst->map' is ignored on input and set on output to
 409  * indicate which fields were extracted. */
 410 void miniflow_extract(struct ofpbuf *packet, const struct pkt_metadata *,
 411                       struct miniflow *dst);
 412 void miniflow_init(struct miniflow *, const struct flow *);
 413 void miniflow_init_with_minimask(struct miniflow *, const struct flow *,
 414                                  const struct minimask *);
 415 void miniflow_clone(struct miniflow *, const struct miniflow *);
 416 void miniflow_move(struct miniflow *dst, struct miniflow *);
 417 void miniflow_destroy(struct miniflow *);
 418
 419 void miniflow_expand(const struct miniflow *, struct flow *);
 420
 421 uint32_t miniflow_get(const struct miniflow *, unsigned int u32_ofs);
 422 uint16_t miniflow_get_vid(const struct miniflow *);
 423 static inline ovs_be64 miniflow_get_metadata(const struct miniflow *);
 424
 425 bool miniflow_equal(const struct miniflow *a, const struct miniflow *b);
 426 bool miniflow_equal_in_minimask(const struct miniflow *a,
 427                                 const struct miniflow *b,
 428                                 const struct minimask *);
 429 bool miniflow_equal_flow_in_minimask(const struct miniflow *a,
 430                                      const struct flow *b,
 431                                      const struct minimask *);
 432 uint32_t miniflow_hash(const struct miniflow *, uint32_t basis);
 433 uint32_t miniflow_hash_in_minimask(const struct miniflow *,
 434                                    const struct minimask *, uint32_t basis);
 435 uint64_t miniflow_get_map_in_range(const struct miniflow *miniflow,
 436                                    uint8_t start, uint8_t end,
 437                                    unsigned int *offset);
 438
 439 \f
 440 /* Compressed flow wildcards. */
 441
 442 /* A sparse representation of a "struct flow_wildcards".
 443  *
 444  * See the large comment on struct miniflow for details.
 445  *
 446  * Note: While miniflow can have zero data for a 1-bit in the map,
 447  * a minimask may not!  We rely on this in the implementation. */
 448 struct minimask {
 449     struct miniflow masks;
 450 };
 451
 452 void minimask_init(struct minimask *, const struct flow_wildcards *);
 453 void minimask_clone(struct minimask *, const struct minimask *);
 454 void minimask_move(struct minimask *dst, struct minimask *src);
 455 void minimask_combine(struct minimask *dst,
 456                       const struct minimask *a, const struct minimask *b,
 457                       uint32_t storage[FLOW_U32S]);
 458 void minimask_destroy(struct minimask *);
 459
 460 void minimask_expand(const struct minimask *, struct flow_wildcards *);
 461
 462 uint32_t minimask_get(const struct minimask *, unsigned int u32_ofs);
 463 uint16_t minimask_get_vid_mask(const struct minimask *);
 464 static inline ovs_be64 minimask_get_metadata_mask(const struct minimask *);
 465
 466 bool minimask_equal(const struct minimask *a, const struct minimask *b);
 467 uint32_t minimask_hash(const struct minimask *, uint32_t basis);
 468
 469 bool minimask_has_extra(const struct minimask *, const struct minimask *);
 470 bool minimask_is_catchall(const struct minimask *);
 471 \f
 472 /* Returns the value of the OpenFlow 1.1+ "metadata" field in 'flow'. */
 473 static inline ovs_be64
 474 miniflow_get_metadata(const struct miniflow *flow)
 475 {
 476     enum { MD_OFS = offsetof(struct flow, metadata) };
 477     BUILD_ASSERT_DECL(MD_OFS % sizeof(uint32_t) == 0);
 478     ovs_be32 hi = (OVS_FORCE ovs_be32) miniflow_get(flow, MD_OFS / 4);
 479     ovs_be32 lo = (OVS_FORCE ovs_be32) miniflow_get(flow, MD_OFS / 4 + 1);
 480
 481     return htonll(((uint64_t) ntohl(hi) << 32) | ntohl(lo));
 482 }
 483
 484 /* Returns the mask for the OpenFlow 1.1+ "metadata" field in 'mask'.
 485  *
 486  * The return value is all-1-bits if 'mask' matches on the whole value of the
 487  * metadata field, all-0-bits if 'mask' entirely wildcards the metadata field,
 488  * or some other value if the metadata field is partially matched, partially
 489  * wildcarded. */
 490 static inline ovs_be64
 491 minimask_get_metadata_mask(const struct minimask *mask)
 492 {
 493     return miniflow_get_metadata(&mask->masks);
 494 }
 495
 496 #endif /* flow.h */