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