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 miniflow;
  34 struct minimask;
  35 struct ofpbuf;
  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 20
  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     ofp_port_t ofp_port;
  77     odp_port_t odp_port;
  78 };
  79
  80 /*
  81 * A flow in the network.
  82 *
  83 * The meaning of 'in_port' is context-dependent.  In most cases, it is a
  84 * 16-bit OpenFlow 1.0 port number.  In the software datapath interface (dpif)
  85 * layer and its implementations (e.g. dpif-linux, dpif-netdev), it is instead
  86 * a 32-bit datapath port number.
  87 */
  88 struct flow {
  89     struct flow_tnl tunnel;     /* Encapsulating tunnel parameters. */
  90     ovs_be64 metadata;          /* OpenFlow Metadata. */
  91     struct in6_addr ipv6_src;   /* IPv6 source address. */
  92     struct in6_addr ipv6_dst;   /* IPv6 destination address. */
  93     struct in6_addr nd_target;  /* IPv6 neighbor discovery (ND) target. */
  94     uint32_t skb_priority;      /* Packet priority for QoS. */
  95     uint32_t regs[FLOW_N_REGS]; /* Registers. */
  96     ovs_be32 nw_src;            /* IPv4 source address. */
  97     ovs_be32 nw_dst;            /* IPv4 destination address. */
  98     ovs_be32 ipv6_label;        /* IPv6 flow label. */
  99     union flow_in_port in_port; /* Input port.*/
 100     uint32_t pkt_mark;          /* Packet mark. */
 101     ovs_be32 mpls_lse;          /* MPLS label stack entry. */
 102     uint16_t mpls_depth;        /* Depth of MPLS stack. */
 103     ovs_be16 vlan_tci;          /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
 104     ovs_be16 dl_type;           /* Ethernet frame type. */
 105     ovs_be16 tp_src;            /* TCP/UDP/SCTP source port. */
 106     ovs_be16 tp_dst;            /* TCP/UDP/SCTP destination port. */
 107     uint8_t dl_src[6];          /* Ethernet source address. */
 108     uint8_t dl_dst[6];          /* Ethernet destination address. */
 109     uint8_t nw_proto;           /* IP protocol or low 8 bits of ARP opcode. */
 110     uint8_t nw_tos;             /* IP ToS (including DSCP and ECN). */
 111     uint8_t arp_sha[6];         /* ARP/ND source hardware address. */
 112     uint8_t arp_tha[6];         /* ARP/ND target hardware address. */
 113     uint8_t nw_ttl;             /* IP TTL/Hop Limit. */
 114     uint8_t nw_frag;            /* FLOW_FRAG_* flags. */
 115     uint8_t zeros[6];
 116 };
 117 BUILD_ASSERT_DECL(sizeof(struct flow) % 4 == 0);
 118
 119 #define FLOW_U32S (sizeof(struct flow) / 4)
 120
 121 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
 122 BUILD_ASSERT_DECL(sizeof(struct flow) == sizeof(struct flow_tnl) + 160 &&
 123                   FLOW_WC_SEQ == 20);
 124
 125 /* Represents the metadata fields of struct flow. */
 126 struct flow_metadata {
 127     ovs_be64 tun_id;                 /* Encapsulating tunnel ID. */
 128     ovs_be32 tun_src;                /* Tunnel outer IPv4 src addr */
 129     ovs_be32 tun_dst;                /* Tunnel outer IPv4 dst addr */
 130     ovs_be64 metadata;               /* OpenFlow 1.1+ metadata field. */
 131     uint32_t regs[FLOW_N_REGS];      /* Registers. */
 132     uint32_t pkt_mark;               /* Packet mark. */
 133     ofp_port_t in_port;              /* OpenFlow port or zero. */
 134 };
 135
 136 void flow_extract(struct ofpbuf *, uint32_t priority, uint32_t mark,
 137                   const struct flow_tnl *, const union flow_in_port *in_port,
 138                   struct flow *);
 139
 140 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
 141 void flow_get_metadata(const struct flow *, struct flow_metadata *);
 142
 143 char *flow_to_string(const struct flow *);
 144 void format_flags(struct ds *ds, const char *(*bit_to_string)(uint32_t),
 145                   uint32_t flags, char del);
 146
 147 void flow_format(struct ds *, const struct flow *);
 148 void flow_print(FILE *, const struct flow *);
 149 static inline int flow_compare_3way(const struct flow *, const struct flow *);
 150 static inline bool flow_equal(const struct flow *, const struct flow *);
 151 static inline size_t flow_hash(const struct flow *, uint32_t basis);
 152
 153 void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
 154 void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
 155 void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
 156
 157 void flow_set_mpls_label(struct flow *flow, ovs_be32 label);
 158 void flow_set_mpls_ttl(struct flow *flow, uint8_t ttl);
 159 void flow_set_mpls_tc(struct flow *flow, uint8_t tc);
 160 void flow_set_mpls_bos(struct flow *flow, uint8_t stack);
 161
 162 void flow_compose(struct ofpbuf *, const struct flow *);
 163
 164 static inline int
 165 flow_compare_3way(const struct flow *a, const struct flow *b)
 166 {
 167     return memcmp(a, b, sizeof *a);
 168 }
 169
 170 static inline bool
 171 flow_equal(const struct flow *a, const struct flow *b)
 172 {
 173     return !flow_compare_3way(a, b);
 174 }
 175
 176 static inline size_t
 177 flow_hash(const struct flow *flow, uint32_t basis)
 178 {
 179     return hash_words((const uint32_t *) flow, sizeof *flow / 4, basis);
 180 }
 181
 182 static inline uint16_t
 183 ofp_to_u16(ofp_port_t ofp_port)
 184 {
 185     return (OVS_FORCE uint16_t) ofp_port;
 186 }
 187
 188 static inline uint32_t
 189 odp_to_u32(odp_port_t odp_port)
 190 {
 191     return (OVS_FORCE uint32_t) odp_port;
 192 }
 193
 194 static inline uint32_t
 195 ofp11_to_u32(ofp11_port_t ofp11_port)
 196 {
 197     return (OVS_FORCE uint32_t) ofp11_port;
 198 }
 199
 200 static inline ofp_port_t
 201 u16_to_ofp(uint16_t port)
 202 {
 203     return OFP_PORT_C(port);
 204 }
 205
 206 static inline odp_port_t
 207 u32_to_odp(uint32_t port)
 208 {
 209     return ODP_PORT_C(port);
 210 }
 211
 212 static inline ofp11_port_t
 213 u32_to_ofp11(uint32_t port)
 214 {
 215     return OFP11_PORT_C(port);
 216 }
 217
 218 static inline uint32_t
 219 hash_ofp_port(ofp_port_t ofp_port)
 220 {
 221     return hash_int(ofp_to_u16(ofp_port), 0);
 222 }
 223
 224 static inline uint32_t
 225 hash_odp_port(odp_port_t odp_port)
 226 {
 227     return hash_int(odp_to_u32(odp_port), 0);
 228 }
 229
 230 uint32_t flow_hash_in_minimask(const struct flow *, const struct minimask *,
 231                                uint32_t basis);
 232 \f
 233 /* Wildcards for a flow.
 234  *
 235  * A 1-bit in each bit in 'masks' indicates that the corresponding bit of
 236  * the flow is significant (must match).  A 0-bit indicates that the
 237  * corresponding bit of the flow is wildcarded (need not match). */
 238 struct flow_wildcards {
 239     struct flow masks;
 240 };
 241
 242 void flow_wildcards_init_catchall(struct flow_wildcards *);
 243 void flow_wildcards_init_exact(struct flow_wildcards *);
 244
 245 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
 246
 247 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
 248                                  int idx, uint32_t mask);
 249
 250 void flow_wildcards_and(struct flow_wildcards *dst,
 251                         const struct flow_wildcards *src1,
 252                         const struct flow_wildcards *src2);
 253 void flow_wildcards_or(struct flow_wildcards *dst,
 254                        const struct flow_wildcards *src1,
 255                        const struct flow_wildcards *src2);
 256 bool flow_wildcards_has_extra(const struct flow_wildcards *,
 257                               const struct flow_wildcards *);
 258
 259 void flow_wildcards_fold_minimask(struct flow_wildcards *,
 260                                   const struct minimask *);
 261
 262 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
 263 bool flow_wildcards_equal(const struct flow_wildcards *,
 264                           const struct flow_wildcards *);
 265 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
 266
 267 void flow_mask_hash_fields(const struct flow *, struct flow_wildcards *,
 268                            enum nx_hash_fields);
 269 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
 270                           uint16_t basis);
 271 const char *flow_hash_fields_to_str(enum nx_hash_fields);
 272 bool flow_hash_fields_valid(enum nx_hash_fields);
 273
 274 uint32_t flow_hash_in_wildcards(const struct flow *,
 275                                 const struct flow_wildcards *,
 276                                 uint32_t basis);
 277
 278 bool flow_equal_except(const struct flow *a, const struct flow *b,
 279                        const struct flow_wildcards *);
 280 \f
 281 /* Compressed flow. */
 282
 283 #define MINI_N_INLINE (sizeof(void *) == 4 ? 7 : 8)
 284 #define MINI_N_MAPS DIV_ROUND_UP(FLOW_U32S, 32)
 285
 286 /* A sparse representation of a "struct flow".
 287  *
 288  * A "struct flow" is fairly large and tends to be mostly zeros.  Sparse
 289  * representation has two advantages.  First, it saves memory.  Second, it
 290  * saves time when the goal is to iterate over only the nonzero parts of the
 291  * struct.
 292  *
 293  * The 'map' member holds one bit for each uint32_t in a "struct flow".  Each
 294  * 0-bit indicates that the corresponding uint32_t is zero, each 1-bit that it
 295  * *may* be nonzero.
 296  *
 297  * 'values' points to the start of an array that has one element for each 1-bit
 298  * in 'map'.  The least-numbered 1-bit is in values[0], the next 1-bit is in
 299  * values[1], and so on.
 300  *
 301  * 'values' may point to a few different locations:
 302  *
 303  *     - If 'map' has MINI_N_INLINE or fewer 1-bits, it may point to
 304  *       'inline_values'.  One hopes that this is the common case.
 305  *
 306  *     - If 'map' has more than MINI_N_INLINE 1-bits, it may point to memory
 307  *       allocated with malloc().
 308  *
 309  *     - The caller could provide storage on the stack for situations where
 310  *       that makes sense.  So far that's only proved useful for
 311  *       minimask_combine(), but the principle works elsewhere.
 312  *
 313  * Elements in 'values' are allowed to be zero.  This is useful for "struct
 314  * minimatch", for which ensuring that the miniflow and minimask members have
 315  * same 'map' allows optimization .
 316  */
 317 struct miniflow {
 318     uint32_t *values;
 319     uint32_t inline_values[MINI_N_INLINE];
 320     uint32_t map[MINI_N_MAPS];
 321 };
 322
 323 void miniflow_init(struct miniflow *, const struct flow *);
 324 void miniflow_init_with_minimask(struct miniflow *, const struct flow *,
 325                                  const struct minimask *);
 326 void miniflow_clone(struct miniflow *, const struct miniflow *);
 327 void miniflow_move(struct miniflow *dst, struct miniflow *);
 328 void miniflow_destroy(struct miniflow *);
 329
 330 void miniflow_expand(const struct miniflow *, struct flow *);
 331
 332 uint32_t miniflow_get(const struct miniflow *, unsigned int u32_ofs);
 333 uint16_t miniflow_get_vid(const struct miniflow *);
 334 static inline ovs_be64 miniflow_get_metadata(const struct miniflow *);
 335
 336 bool miniflow_equal(const struct miniflow *a, const struct miniflow *b);
 337 bool miniflow_equal_in_minimask(const struct miniflow *a,
 338                                 const struct miniflow *b,
 339                                 const struct minimask *);
 340 bool miniflow_equal_flow_in_minimask(const struct miniflow *a,
 341                                      const struct flow *b,
 342                                      const struct minimask *);
 343 uint32_t miniflow_hash(const struct miniflow *, uint32_t basis);
 344 uint32_t miniflow_hash_in_minimask(const struct miniflow *,
 345                                    const struct minimask *, uint32_t basis);
 346 \f
 347 /* Compressed flow wildcards. */
 348
 349 /* A sparse representation of a "struct flow_wildcards".
 350  *
 351  * See the large comment on struct miniflow for details. */
 352 struct minimask {
 353     struct miniflow masks;
 354 };
 355
 356 void minimask_init(struct minimask *, const struct flow_wildcards *);
 357 void minimask_clone(struct minimask *, const struct minimask *);
 358 void minimask_move(struct minimask *dst, struct minimask *src);
 359 void minimask_combine(struct minimask *dst,
 360                       const struct minimask *a, const struct minimask *b,
 361                       uint32_t storage[FLOW_U32S]);
 362 void minimask_destroy(struct minimask *);
 363
 364 void minimask_expand(const struct minimask *, struct flow_wildcards *);
 365
 366 uint32_t minimask_get(const struct minimask *, unsigned int u32_ofs);
 367 uint16_t minimask_get_vid_mask(const struct minimask *);
 368 static inline ovs_be64 minimask_get_metadata_mask(const struct minimask *);
 369
 370 bool minimask_equal(const struct minimask *a, const struct minimask *b);
 371 uint32_t minimask_hash(const struct minimask *, uint32_t basis);
 372
 373 bool minimask_has_extra(const struct minimask *, const struct minimask *);
 374 bool minimask_is_catchall(const struct minimask *);
 375 \f
 376 /* Returns the value of the OpenFlow 1.1+ "metadata" field in 'flow'. */
 377 static inline ovs_be64
 378 miniflow_get_metadata(const struct miniflow *flow)
 379 {
 380     enum { MD_OFS = offsetof(struct flow, metadata) };
 381     BUILD_ASSERT_DECL(MD_OFS % sizeof(uint32_t) == 0);
 382     ovs_be32 hi = (OVS_FORCE ovs_be32) miniflow_get(flow, MD_OFS / 4);
 383     ovs_be32 lo = (OVS_FORCE ovs_be32) miniflow_get(flow, MD_OFS / 4 + 1);
 384
 385     return htonll(((uint64_t) ntohl(hi) << 32) | ntohl(lo));
 386 }
 387
 388 /* Returns the mask for the OpenFlow 1.1+ "metadata" field in 'mask'.
 389  *
 390  * The return value is all-1-bits if 'mask' matches on the whole value of the
 391  * metadata field, all-0-bits if 'mask' entirely wildcards the metadata field,
 392  * or some other value if the metadata field is partially matched, partially
 393  * wildcarded. */
 394 static inline ovs_be64
 395 minimask_get_metadata_mask(const struct minimask *mask)
 396 {
 397     return miniflow_get_metadata(&mask->masks);
 398 }
 399
 400 #endif /* flow.h */