lib/flow.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 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 "openflow/nicira-ext.h"
  25 #include "openflow/openflow.h"
  26 #include "hash.h"
  27 #include "util.h"
  28
  29 struct dpif_flow_stats;
  30 struct ds;
  31 struct flow_wildcards;
  32 struct miniflow;
  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 17
  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 struct flow {
  57     ovs_be64 tun_id;            /* Encapsulating tunnel ID. */
  58     ovs_be64 metadata;          /* OpenFlow Metadata. */
  59     struct in6_addr ipv6_src;   /* IPv6 source address. */
  60     struct in6_addr ipv6_dst;   /* IPv6 destination address. */
  61     struct in6_addr nd_target;  /* IPv6 neighbor discovery (ND) target. */
  62     uint32_t skb_priority;      /* Packet priority for QoS. */
  63     uint32_t regs[FLOW_N_REGS]; /* Registers. */
  64     ovs_be32 nw_src;            /* IPv4 source address. */
  65     ovs_be32 nw_dst;            /* IPv4 destination address. */
  66     ovs_be32 ipv6_label;        /* IPv6 flow label. */
  67     uint16_t in_port;           /* OpenFlow port number of input port. */
  68     ovs_be16 vlan_tci;          /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
  69     ovs_be16 dl_type;           /* Ethernet frame type. */
  70     ovs_be16 tp_src;            /* TCP/UDP source port. */
  71     ovs_be16 tp_dst;            /* TCP/UDP destination port. */
  72     uint8_t dl_src[6];          /* Ethernet source address. */
  73     uint8_t dl_dst[6];          /* Ethernet destination address. */
  74     uint8_t nw_proto;           /* IP protocol or low 8 bits of ARP opcode. */
  75     uint8_t nw_tos;             /* IP ToS (including DSCP and ECN). */
  76     uint8_t arp_sha[6];         /* ARP/ND source hardware address. */
  77     uint8_t arp_tha[6];         /* ARP/ND target hardware address. */
  78     uint8_t nw_ttl;             /* IP TTL/Hop Limit. */
  79     uint8_t nw_frag;            /* FLOW_FRAG_* flags. */
  80     uint8_t zeros[2];           /* Must be zero. */
  81 };
  82 BUILD_ASSERT_DECL(sizeof(struct flow) % 8 == 0);
  83
  84 #define FLOW_U32S (sizeof(struct flow) / 4)
  85
  86 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
  87 BUILD_ASSERT_DECL(sizeof(struct flow) == 152 && FLOW_WC_SEQ == 17);
  88
  89 /* Represents the metadata fields of struct flow. */
  90 struct flow_metadata {
  91     ovs_be64 tun_id;                 /* Encapsulating tunnel ID. */
  92     ovs_be64 metadata;               /* OpenFlow 1.1+ metadata field. */
  93     uint32_t regs[FLOW_N_REGS];      /* Registers. */
  94     uint16_t in_port;                /* OpenFlow port or zero. */
  95 };
  96
  97 void flow_extract(struct ofpbuf *, uint32_t priority, ovs_be64 tun_id,
  98                   uint16_t in_port, struct flow *);
  99 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
 100 void flow_get_metadata(const struct flow *, struct flow_metadata *);
 101
 102 char *flow_to_string(const struct flow *);
 103 void flow_format(struct ds *, const struct flow *);
 104 void flow_print(FILE *, const struct flow *);
 105 static inline int flow_compare_3way(const struct flow *, const struct flow *);
 106 static inline bool flow_equal(const struct flow *, const struct flow *);
 107 static inline size_t flow_hash(const struct flow *, uint32_t basis);
 108
 109 void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
 110 void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
 111 void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
 112
 113 void flow_compose(struct ofpbuf *, const struct flow *);
 114
 115 static inline int
 116 flow_compare_3way(const struct flow *a, const struct flow *b)
 117 {
 118     return memcmp(a, b, sizeof *a);
 119 }
 120
 121 static inline bool
 122 flow_equal(const struct flow *a, const struct flow *b)
 123 {
 124     return !flow_compare_3way(a, b);
 125 }
 126
 127 static inline size_t
 128 flow_hash(const struct flow *flow, uint32_t basis)
 129 {
 130     return hash_words((const uint32_t *) flow, sizeof *flow / 4, basis);
 131 }
 132
 133 uint32_t flow_hash_in_minimask(const struct flow *, const struct minimask *,
 134                                uint32_t basis);
 135 \f
 136 /* Wildcards for a flow.
 137  *
 138  * A 1-bit in each bit in 'masks' indicates that the corresponding bit of
 139  * the flow is significant (must match).  A 0-bit indicates that the
 140  * corresponding bit of the flow is wildcarded (need not match). */
 141 struct flow_wildcards {
 142     struct flow masks;
 143 };
 144
 145 void flow_wildcards_init_catchall(struct flow_wildcards *);
 146 void flow_wildcards_init_exact(struct flow_wildcards *);
 147
 148 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
 149
 150 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
 151                                  int idx, uint32_t mask);
 152
 153 void flow_wildcards_combine(struct flow_wildcards *dst,
 154                             const struct flow_wildcards *src1,
 155                             const struct flow_wildcards *src2);
 156 bool flow_wildcards_has_extra(const struct flow_wildcards *,
 157                               const struct flow_wildcards *);
 158
 159 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
 160 bool flow_wildcards_equal(const struct flow_wildcards *,
 161                           const struct flow_wildcards *);
 162 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
 163
 164 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
 165                           uint16_t basis);
 166 const char *flow_hash_fields_to_str(enum nx_hash_fields);
 167 bool flow_hash_fields_valid(enum nx_hash_fields);
 168
 169 bool flow_equal_except(const struct flow *a, const struct flow *b,
 170                        const struct flow_wildcards *);
 171 \f
 172 /* Compressed flow. */
 173
 174 #define MINI_N_INLINE (sizeof(void *) == 4 ? 7 : 8)
 175 #define MINI_N_MAPS DIV_ROUND_UP(FLOW_U32S, 32)
 176
 177 /* A sparse representation of a "struct flow".
 178  *
 179  * A "struct flow" is fairly large and tends to be mostly zeros.  Sparse
 180  * representation has two advantages.  First, it saves memory.  Second, it
 181  * saves time when the goal is to iterate over only the nonzero parts of the
 182  * struct.
 183  *
 184  * The 'map' member holds one bit for each uint32_t in a "struct flow".  Each
 185  * 0-bit indicates that the corresponding uint32_t is zero, each 1-bit that it
 186  * is nonzero.
 187  *
 188  * 'values' points to the start of an array that has one element for each 1-bit
 189  * in 'map'.  The least-numbered 1-bit is in values[0], the next 1-bit is in
 190  * values[1], and so on.
 191  *
 192  * 'values' may point to a few different locations:
 193  *
 194  *     - If 'map' has MINI_N_INLINE or fewer 1-bits, it may point to
 195  *       'inline_values'.  One hopes that this is the common case.
 196  *
 197  *     - If 'map' has more than MINI_N_INLINE 1-bits, it may point to memory
 198  *       allocated with malloc().
 199  *
 200  *     - The caller could provide storage on the stack for situations where
 201  *       that makes sense.  So far that's only proved useful for
 202  *       minimask_combine(), but the principle works elsewhere.
 203  *
 204  * The implementation maintains and depends on the invariant that every element
 205  * in 'values' is nonzero; that is, wherever a 1-bit appears in 'map', the
 206  * corresponding element of 'values' must be nonzero.
 207  */
 208 struct miniflow {
 209     uint32_t *values;
 210     uint32_t inline_values[MINI_N_INLINE];
 211     uint32_t map[MINI_N_MAPS];
 212 };
 213
 214 void miniflow_init(struct miniflow *, const struct flow *);
 215 void miniflow_clone(struct miniflow *, const struct miniflow *);
 216 void miniflow_destroy(struct miniflow *);
 217
 218 void miniflow_expand(const struct miniflow *, struct flow *);
 219
 220 uint32_t miniflow_get(const struct miniflow *, unsigned int u32_ofs);
 221 uint16_t miniflow_get_vid(const struct miniflow *);
 222
 223 bool miniflow_equal(const struct miniflow *a, const struct miniflow *b);
 224 bool miniflow_equal_in_minimask(const struct miniflow *a,
 225                                 const struct miniflow *b,
 226                                 const struct minimask *);
 227 bool miniflow_equal_flow_in_minimask(const struct miniflow *a,
 228                                      const struct flow *b,
 229                                      const struct minimask *);
 230 uint32_t miniflow_hash(const struct miniflow *, uint32_t basis);
 231 uint32_t miniflow_hash_in_minimask(const struct miniflow *,
 232                                    const struct minimask *, uint32_t basis);
 233 \f
 234 /* Compressed flow wildcards. */
 235
 236 /* A sparse representation of a "struct flow_wildcards".
 237  *
 238  * See the large comment on struct miniflow for details. */
 239 struct minimask {
 240     struct miniflow masks;
 241 };
 242
 243 void minimask_init(struct minimask *, const struct flow_wildcards *);
 244 void minimask_clone(struct minimask *, const struct minimask *);
 245 void minimask_combine(struct minimask *dst,
 246                       const struct minimask *a, const struct minimask *b,
 247                       uint32_t storage[FLOW_U32S]);
 248 void minimask_destroy(struct minimask *);
 249
 250 void minimask_expand(const struct minimask *, struct flow_wildcards *);
 251
 252 uint32_t minimask_get(const struct minimask *, unsigned int u32_ofs);
 253 uint16_t minimask_get_vid_mask(const struct minimask *);
 254
 255 bool minimask_equal(const struct minimask *a, const struct minimask *b);
 256 uint32_t minimask_hash(const struct minimask *, uint32_t basis);
 257
 258 bool minimask_has_extra(const struct minimask *, const struct minimask *);
 259 bool minimask_is_catchall(const struct minimask *);
 260
 261 #endif /* flow.h */