lib/flow.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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
  36 /* This sequence number should be incremented whenever anything involving flows
  37  * or the wildcarding of flows changes.  This will cause build assertion
  38  * failures in places which likely need to be updated. */
  39 #define FLOW_WC_SEQ 23
  40
  41 #define FLOW_N_REGS 8
  42 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
  43
  44 /* Used for struct flow's dl_type member for frames that have no Ethernet
  45  * type, that is, pure 802.2 frames. */
  46 #define FLOW_DL_TYPE_NONE 0x5ff
  47
  48 /* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */
  49 #define FLOW_NW_FRAG_ANY   (1 << 0) /* Set for any IP frag. */
  50 #define FLOW_NW_FRAG_LATER (1 << 1) /* Set for IP frag with nonzero offset. */
  51 #define FLOW_NW_FRAG_MASK  (FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER)
  52
  53 BUILD_ASSERT_DECL(FLOW_NW_FRAG_ANY == NX_IP_FRAG_ANY);
  54 BUILD_ASSERT_DECL(FLOW_NW_FRAG_LATER == NX_IP_FRAG_LATER);
  55
  56 #define FLOW_TNL_F_DONT_FRAGMENT (1 << 0)
  57 #define FLOW_TNL_F_CSUM (1 << 1)
  58 #define FLOW_TNL_F_KEY (1 << 2)
  59
  60 const char *flow_tun_flag_to_string(uint32_t flags);
  61
  62 struct flow_tnl {
  63     ovs_be64 tun_id;
  64     ovs_be32 ip_src;
  65     ovs_be32 ip_dst;
  66     uint16_t flags;
  67     uint8_t ip_tos;
  68     uint8_t ip_ttl;
  69 };
  70
  71 /* Unfortunately, a "struct flow" sometimes has to handle OpenFlow port
  72  * numbers and other times datapath (dpif) port numbers.  This union allows
  73  * access to both. */
  74 union flow_in_port {
  75     ofp_port_t ofp_port;
  76     odp_port_t odp_port;
  77 };
  78
  79 /*
  80  * A flow in the network.
  81  *
  82  * Must be initialized to all zeros to make any compiler-induced padding
  83  * zeroed.  Helps also in keeping unused fields (such as mutually exclusive
  84  * IPv4 and IPv6 addresses) zeroed out.
  85  *
  86  * The meaning of 'in_port' is context-dependent.  In most cases, it is a
  87  * 16-bit OpenFlow 1.0 port number.  In the software datapath interface (dpif)
  88  * layer and its implementations (e.g. dpif-linux, dpif-netdev), it is instead
  89  * a 32-bit datapath port number.
  90  *
  91  * The fields are organized in four segments to facilitate staged lookup, where
  92  * lower layer fields are first used to determine if the later fields need to
  93  * be looked at.  This enables better wildcarding for datapath flows.
  94  */
  95 struct flow {
  96     /* L1 */
  97     struct flow_tnl tunnel;     /* Encapsulating tunnel parameters. */
  98     ovs_be64 metadata;          /* OpenFlow Metadata. */
  99     uint32_t regs[FLOW_N_REGS]; /* Registers. */
 100     uint32_t skb_priority;      /* Packet priority for QoS. */
 101     uint32_t pkt_mark;          /* Packet mark. */
 102     union flow_in_port in_port; /* Input port.*/
 103
 104     /* L2 */
 105     uint8_t dl_src[6];          /* Ethernet source address. */
 106     uint8_t dl_dst[6];          /* Ethernet destination address. */
 107     ovs_be16 dl_type;           /* Ethernet frame type. */
 108     ovs_be16 vlan_tci;          /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
 109
 110     /* L3 */
 111     ovs_be32 mpls_lse;          /* MPLS label stack entry. */
 112     struct in6_addr ipv6_src;   /* IPv6 source address. */
 113     struct in6_addr ipv6_dst;   /* IPv6 destination address. */
 114     struct in6_addr nd_target;  /* IPv6 neighbor discovery (ND) target. */
 115     ovs_be32 ipv6_label;        /* IPv6 flow label. */
 116     ovs_be32 nw_src;            /* IPv4 source address. */
 117     ovs_be32 nw_dst;            /* IPv4 destination address. */
 118     uint8_t nw_frag;            /* FLOW_FRAG_* flags. */
 119     uint8_t nw_tos;             /* IP ToS (including DSCP and ECN). */
 120     uint8_t nw_ttl;             /* IP TTL/Hop Limit. */
 121     uint8_t nw_proto;           /* IP protocol or low 8 bits of ARP opcode. */
 122     uint8_t arp_sha[6];         /* ARP/ND source hardware address. */
 123     uint8_t arp_tha[6];         /* ARP/ND target hardware address. */
 124     ovs_be16 tcp_flags;         /* TCP flags. With L3 to avoid matching L4. */
 125     ovs_be16 pad;               /* Padding. */
 126     /* L4 */
 127     ovs_be16 tp_src;            /* TCP/UDP/SCTP source port. */
 128     ovs_be16 tp_dst;            /* TCP/UDP/SCTP destination port.
 129                                  * Keep last for the BUILD_ASSERT_DECL below */
 130 };
 131 BUILD_ASSERT_DECL(sizeof(struct flow) % 4 == 0);
 132
 133 #define FLOW_U32S (sizeof(struct flow) / 4)
 134
 135 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
 136 BUILD_ASSERT_DECL(offsetof(struct flow, tp_dst) + 2
 137                   == sizeof(struct flow_tnl) + 156
 138                   && FLOW_WC_SEQ == 23);
 139
 140 /* Incremental points at which flow classification may be performed in
 141  * segments.
 142  * This is located here since this is dependent on the structure of the
 143  * struct flow defined above:
 144  * Each offset must be on a distint, successive U32 boundary srtictly
 145  * within the struct flow. */
 146 enum {
 147     FLOW_SEGMENT_1_ENDS_AT = offsetof(struct flow, dl_src),
 148     FLOW_SEGMENT_2_ENDS_AT = offsetof(struct flow, mpls_lse),
 149     FLOW_SEGMENT_3_ENDS_AT = offsetof(struct flow, tp_src),
 150 };
 151 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT % 4 == 0);
 152 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT % 4 == 0);
 153 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT % 4 == 0);
 154 BUILD_ASSERT_DECL(                     0 < FLOW_SEGMENT_1_ENDS_AT);
 155 BUILD_ASSERT_DECL(FLOW_SEGMENT_1_ENDS_AT < FLOW_SEGMENT_2_ENDS_AT);
 156 BUILD_ASSERT_DECL(FLOW_SEGMENT_2_ENDS_AT < FLOW_SEGMENT_3_ENDS_AT);
 157 BUILD_ASSERT_DECL(FLOW_SEGMENT_3_ENDS_AT < sizeof(struct flow));
 158
 159 extern const uint8_t flow_segment_u32s[];
 160
 161 /* Represents the metadata fields of struct flow. */
 162 struct flow_metadata {
 163     ovs_be64 tun_id;                 /* Encapsulating tunnel ID. */
 164     ovs_be32 tun_src;                /* Tunnel outer IPv4 src addr */
 165     ovs_be32 tun_dst;                /* Tunnel outer IPv4 dst addr */
 166     ovs_be64 metadata;               /* OpenFlow 1.1+ metadata field. */
 167     uint32_t regs[FLOW_N_REGS];      /* Registers. */
 168     uint32_t pkt_mark;               /* Packet mark. */
 169     ofp_port_t in_port;              /* OpenFlow port or zero. */
 170 };
 171
 172 void flow_extract(struct ofpbuf *, uint32_t priority, uint32_t mark,
 173                   const struct flow_tnl *, const union flow_in_port *in_port,
 174                   struct flow *);
 175
 176 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
 177 void flow_get_metadata(const struct flow *, struct flow_metadata *);
 178
 179 char *flow_to_string(const struct flow *);
 180 void format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
 181                   uint32_t flags, char del);
 182 void format_flags_masked(struct ds *ds, const char *name,
 183                          const char *(*bit_to_string)(uint32_t),
 184                          uint32_t flags, uint32_t mask);
 185
 186 void flow_format(struct ds *, const struct flow *);
 187 void flow_print(FILE *, const struct flow *);
 188 static inline int flow_compare_3way(const struct flow *, const struct flow *);
 189 static inline bool flow_equal(const struct flow *, const struct flow *);
 190 static inline size_t flow_hash(const struct flow *, uint32_t basis);
 191
 192 void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
 193 void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
 194 void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
 195
 196 void flow_set_mpls_label(struct flow *flow, ovs_be32 label);
 197 void flow_set_mpls_ttl(struct flow *flow, uint8_t ttl);
 198 void flow_set_mpls_tc(struct flow *flow, uint8_t tc);
 199 void flow_set_mpls_bos(struct flow *flow, uint8_t stack);
 200
 201 void flow_compose(struct ofpbuf *, const struct flow *);
 202
 203 static inline int
 204 flow_compare_3way(const struct flow *a, const struct flow *b)
 205 {
 206     return memcmp(a, b, sizeof *a);
 207 }
 208
 209 static inline bool
 210 flow_equal(const struct flow *a, const struct flow *b)
 211 {
 212     return !flow_compare_3way(a, b);
 213 }
 214
 215 static inline size_t
 216 flow_hash(const struct flow *flow, uint32_t basis)
 217 {
 218     return hash_words((const uint32_t *) flow, sizeof *flow / 4, basis);
 219 }
 220
 221 static inline uint16_t
 222 ofp_to_u16(ofp_port_t ofp_port)
 223 {
 224     return (OVS_FORCE uint16_t) ofp_port;
 225 }
 226
 227 static inline uint32_t
 228 odp_to_u32(odp_port_t odp_port)
 229 {
 230     return (OVS_FORCE uint32_t) odp_port;
 231 }
 232
 233 static inline uint32_t
 234 ofp11_to_u32(ofp11_port_t ofp11_port)
 235 {
 236     return (OVS_FORCE uint32_t) ofp11_port;
 237 }
 238
 239 static inline ofp_port_t
 240 u16_to_ofp(uint16_t port)
 241 {
 242     return OFP_PORT_C(port);
 243 }
 244
 245 static inline odp_port_t
 246 u32_to_odp(uint32_t port)
 247 {
 248     return ODP_PORT_C(port);
 249 }
 250
 251 static inline ofp11_port_t
 252 u32_to_ofp11(uint32_t port)
 253 {
 254     return OFP11_PORT_C(port);
 255 }
 256
 257 static inline uint32_t
 258 hash_ofp_port(ofp_port_t ofp_port)
 259 {
 260     return hash_int(ofp_to_u16(ofp_port), 0);
 261 }
 262
 263 static inline uint32_t
 264 hash_odp_port(odp_port_t odp_port)
 265 {
 266     return hash_int(odp_to_u32(odp_port), 0);
 267 }
 268
 269 uint32_t flow_hash_in_minimask(const struct flow *, const struct minimask *,
 270                                uint32_t basis);
 271 uint32_t flow_hash_in_minimask_range(const struct flow *,
 272                                      const struct minimask *,
 273                                      uint8_t start, uint8_t end,
 274                                      uint32_t *basis);
 275 \f
 276 /* Wildcards for a flow.
 277  *
 278  * A 1-bit in each bit in 'masks' indicates that the corresponding bit of
 279  * the flow is significant (must match).  A 0-bit indicates that the
 280  * corresponding bit of the flow is wildcarded (need not match). */
 281 struct flow_wildcards {
 282     struct flow masks;
 283 };
 284
 285 void flow_wildcards_init_catchall(struct flow_wildcards *);
 286
 287 void flow_wildcards_clear_non_packet_fields(struct flow_wildcards *);
 288
 289 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
 290
 291 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
 292                                  int idx, uint32_t mask);
 293
 294 void flow_wildcards_and(struct flow_wildcards *dst,
 295                         const struct flow_wildcards *src1,
 296                         const struct flow_wildcards *src2);
 297 void flow_wildcards_or(struct flow_wildcards *dst,
 298                        const struct flow_wildcards *src1,
 299                        const struct flow_wildcards *src2);
 300 bool flow_wildcards_has_extra(const struct flow_wildcards *,
 301                               const struct flow_wildcards *);
 302
 303 void flow_wildcards_fold_minimask(struct flow_wildcards *,
 304                                   const struct minimask *);
 305 void flow_wildcards_fold_minimask_range(struct flow_wildcards *,
 306                                         const struct minimask *,
 307                                         uint8_t start, uint8_t end);
 308
 309 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
 310 bool flow_wildcards_equal(const struct flow_wildcards *,
 311                           const struct flow_wildcards *);
 312 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
 313
 314 /* Initialize a flow with random fields that matter for nx_hash_fields. */
 315 void flow_random_hash_fields(struct flow *);
 316 void flow_mask_hash_fields(const struct flow *, struct flow_wildcards *,
 317                            enum nx_hash_fields);
 318 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
 319                           uint16_t basis);
 320 const char *flow_hash_fields_to_str(enum nx_hash_fields);
 321 bool flow_hash_fields_valid(enum nx_hash_fields);
 322
 323 uint32_t flow_hash_in_wildcards(const struct flow *,
 324                                 const struct flow_wildcards *,
 325                                 uint32_t basis);
 326
 327 bool flow_equal_except(const struct flow *a, const struct flow *b,
 328                        const struct flow_wildcards *);
 329 \f
 330 /* Compressed flow. */
 331
 332 #define MINI_N_INLINE (sizeof(void *) == 4 ? 7 : 8)
 333 BUILD_ASSERT_DECL(FLOW_U32S <= 64);
 334
 335 /* A sparse representation of a "struct flow".
 336  *
 337  * A "struct flow" is fairly large and tends to be mostly zeros.  Sparse
 338  * representation has two advantages.  First, it saves memory.  Second, it
 339  * saves time when the goal is to iterate over only the nonzero parts of the
 340  * struct.
 341  *
 342  * The 'map' member holds one bit for each uint32_t in a "struct flow".  Each
 343  * 0-bit indicates that the corresponding uint32_t is zero, each 1-bit that it
 344  * *may* be nonzero.
 345  *
 346  * 'values' points to the start of an array that has one element for each 1-bit
 347  * in 'map'.  The least-numbered 1-bit is in values[0], the next 1-bit is in
 348  * values[1], and so on.
 349  *
 350  * 'values' may point to a few different locations:
 351  *
 352  *     - If 'map' has MINI_N_INLINE or fewer 1-bits, it may point to
 353  *       'inline_values'.  One hopes that this is the common case.
 354  *
 355  *     - If 'map' has more than MINI_N_INLINE 1-bits, it may point to memory
 356  *       allocated with malloc().
 357  *
 358  *     - The caller could provide storage on the stack for situations where
 359  *       that makes sense.  So far that's only proved useful for
 360  *       minimask_combine(), but the principle works elsewhere.
 361  *
 362  * Elements in 'values' are allowed to be zero.  This is useful for "struct
 363  * minimatch", for which ensuring that the miniflow and minimask members have
 364  * same 'map' allows optimization .
 365  */
 366 struct miniflow {
 367     uint64_t map;
 368     uint32_t *values;
 369     uint32_t inline_values[MINI_N_INLINE];
 370 };
 371
 372 void miniflow_init(struct miniflow *, const struct flow *);
 373 void miniflow_init_with_minimask(struct miniflow *, const struct flow *,
 374                                  const struct minimask *);
 375 void miniflow_clone(struct miniflow *, const struct miniflow *);
 376 void miniflow_move(struct miniflow *dst, struct miniflow *);
 377 void miniflow_destroy(struct miniflow *);
 378
 379 void miniflow_expand(const struct miniflow *, struct flow *);
 380
 381 uint32_t miniflow_get(const struct miniflow *, unsigned int u32_ofs);
 382 uint16_t miniflow_get_vid(const struct miniflow *);
 383 static inline ovs_be64 miniflow_get_metadata(const struct miniflow *);
 384
 385 bool miniflow_equal(const struct miniflow *a, const struct miniflow *b);
 386 bool miniflow_equal_in_minimask(const struct miniflow *a,
 387                                 const struct miniflow *b,
 388                                 const struct minimask *);
 389 bool miniflow_equal_flow_in_minimask(const struct miniflow *a,
 390                                      const struct flow *b,
 391                                      const struct minimask *);
 392 uint32_t miniflow_hash(const struct miniflow *, uint32_t basis);
 393 uint32_t miniflow_hash_in_minimask(const struct miniflow *,
 394                                    const struct minimask *, uint32_t basis);
 395 uint64_t miniflow_get_map_in_range(const struct miniflow *, uint8_t start,
 396                                    uint8_t end, const uint32_t **data);
 397 \f
 398 /* Compressed flow wildcards. */
 399
 400 /* A sparse representation of a "struct flow_wildcards".
 401  *
 402  * See the large comment on struct miniflow for details. */
 403 struct minimask {
 404     struct miniflow masks;
 405 };
 406
 407 void minimask_init(struct minimask *, const struct flow_wildcards *);
 408 void minimask_clone(struct minimask *, const struct minimask *);
 409 void minimask_move(struct minimask *dst, struct minimask *src);
 410 void minimask_combine(struct minimask *dst,
 411                       const struct minimask *a, const struct minimask *b,
 412                       uint32_t storage[FLOW_U32S]);
 413 void minimask_destroy(struct minimask *);
 414
 415 void minimask_expand(const struct minimask *, struct flow_wildcards *);
 416
 417 uint32_t minimask_get(const struct minimask *, unsigned int u32_ofs);
 418 uint16_t minimask_get_vid_mask(const struct minimask *);
 419 static inline ovs_be64 minimask_get_metadata_mask(const struct minimask *);
 420
 421 bool minimask_equal(const struct minimask *a, const struct minimask *b);
 422 uint32_t minimask_hash(const struct minimask *, uint32_t basis);
 423
 424 bool minimask_has_extra(const struct minimask *, const struct minimask *);
 425 bool minimask_is_catchall(const struct minimask *);
 426 \f
 427 /* Returns the value of the OpenFlow 1.1+ "metadata" field in 'flow'. */
 428 static inline ovs_be64
 429 miniflow_get_metadata(const struct miniflow *flow)
 430 {
 431     enum { MD_OFS = offsetof(struct flow, metadata) };
 432     BUILD_ASSERT_DECL(MD_OFS % sizeof(uint32_t) == 0);
 433     ovs_be32 hi = (OVS_FORCE ovs_be32) miniflow_get(flow, MD_OFS / 4);
 434     ovs_be32 lo = (OVS_FORCE ovs_be32) miniflow_get(flow, MD_OFS / 4 + 1);
 435
 436     return htonll(((uint64_t) ntohl(hi) << 32) | ntohl(lo));
 437 }
 438
 439 /* Returns the mask for the OpenFlow 1.1+ "metadata" field in 'mask'.
 440  *
 441  * The return value is all-1-bits if 'mask' matches on the whole value of the
 442  * metadata field, all-0-bits if 'mask' entirely wildcards the metadata field,
 443  * or some other value if the metadata field is partially matched, partially
 444  * wildcarded. */
 445 static inline ovs_be64
 446 minimask_get_metadata_mask(const struct minimask *mask)
 447 {
 448     return miniflow_get_metadata(&mask->masks);
 449 }
 450
 451 #endif /* flow.h */