lib/flow.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
   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 ofp_match;
  33 struct ofpbuf;
  34
  35 /* This sequence number should be incremented whenever anything involving flows
  36  * or the wildcarding of flows changes.  This will cause build assertion
  37  * failures in places which likely need to be updated. */
  38 #define FLOW_WC_SEQ 3
  39
  40 #define FLOW_N_REGS 5
  41 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
  42
  43 /* Used for struct flow's dl_type member for frames that have no Ethernet
  44  * type, that is, pure 802.2 frames. */
  45 #define FLOW_DL_TYPE_NONE 0x5ff
  46
  47 /* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */
  48 #define FLOW_FRAG_ANY   (1 << 0) /* Set for any IP fragment. */
  49 #define FLOW_FRAG_LATER (1 << 1) /* Set for IP fragment with nonzero offset. */
  50 #define FLOW_FRAG_MASK  (FLOW_FRAG_ANY | FLOW_FRAG_LATER)
  51
  52 BUILD_ASSERT_DECL(FLOW_FRAG_ANY == NX_IP_FRAG_ANY);
  53 BUILD_ASSERT_DECL(FLOW_FRAG_LATER == NX_IP_FRAG_LATER);
  54
  55 struct flow {
  56     ovs_be64 tun_id;            /* Encapsulating tunnel ID. */
  57     uint32_t regs[FLOW_N_REGS]; /* Registers. */
  58     ovs_be32 nw_src;            /* IPv4 source address. */
  59     ovs_be32 nw_dst;            /* IPv4 destination address. */
  60     uint16_t in_port;           /* OpenFlow port number of input port. */
  61     ovs_be16 vlan_tci;          /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
  62     ovs_be16 dl_type;           /* Ethernet frame type. */
  63     ovs_be16 tp_src;            /* TCP/UDP source port. */
  64     ovs_be16 tp_dst;            /* TCP/UDP destination port. */
  65     uint8_t dl_src[6];          /* Ethernet source address. */
  66     uint8_t dl_dst[6];          /* Ethernet destination address. */
  67     uint8_t nw_proto;           /* IP protocol or low 8 bits of ARP opcode. */
  68     uint8_t tos_frag;           /* IP ToS in top bits, FLOW_FRAG_* in low. */
  69     uint8_t arp_sha[6];         /* ARP/ND source hardware address. */
  70     uint8_t arp_tha[6];         /* ARP/ND target hardware address. */
  71     struct in6_addr ipv6_src;   /* IPv6 source address. */
  72     struct in6_addr ipv6_dst;   /* IPv6 destination address. */
  73     struct in6_addr nd_target;  /* IPv6 neighbor discovery (ND) target. */
  74 };
  75
  76 /* Assert that there are FLOW_SIG_SIZE bytes of significant data in "struct
  77  * flow", followed by FLOW_PAD_SIZE bytes of padding. */
  78 #define FLOW_SIG_SIZE (100 + FLOW_N_REGS * 4)
  79 #define FLOW_PAD_SIZE 0
  80 BUILD_ASSERT_DECL(offsetof(struct flow, nd_target) == FLOW_SIG_SIZE - 16);
  81 BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->nd_target) == 16);
  82 BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE);
  83
  84 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
  85 BUILD_ASSERT_DECL(FLOW_SIG_SIZE == 120 && FLOW_WC_SEQ == 3);
  86
  87 void flow_extract(struct ofpbuf *, ovs_be64 tun_id, uint16_t in_port,
  88                   struct flow *);
  89 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
  90
  91 char *flow_to_string(const struct flow *);
  92 void flow_format(struct ds *, const struct flow *);
  93 void flow_print(FILE *, const struct flow *);
  94 static inline int flow_compare(const struct flow *, const struct flow *);
  95 static inline bool flow_equal(const struct flow *, const struct flow *);
  96 static inline size_t flow_hash(const struct flow *, uint32_t basis);
  97
  98 void flow_compose(struct ofpbuf *, const struct flow *);
  99
 100 static inline int
 101 flow_compare(const struct flow *a, const struct flow *b)
 102 {
 103     return memcmp(a, b, FLOW_SIG_SIZE);
 104 }
 105
 106 static inline bool
 107 flow_equal(const struct flow *a, const struct flow *b)
 108 {
 109     return !flow_compare(a, b);
 110 }
 111
 112 static inline size_t
 113 flow_hash(const struct flow *flow, uint32_t basis)
 114 {
 115     return hash_bytes(flow, FLOW_SIG_SIZE, basis);
 116 }
 117
 118 /* Open vSwitch flow wildcard bits.
 119  *
 120  * These are used only internally to Open vSwitch, in the 'wildcards' member of
 121  * struct flow_wildcards.  They never appear in the wire protocol in this
 122  * form. */
 123
 124 typedef unsigned int OVS_BITWISE flow_wildcards_t;
 125
 126 /* Same values and meanings as corresponding OFPFW_* bits. */
 127 #define FWW_IN_PORT     ((OVS_FORCE flow_wildcards_t) (1 << 0))
 128 #define FWW_DL_SRC      ((OVS_FORCE flow_wildcards_t) (1 << 2))
 129 #define FWW_DL_DST      ((OVS_FORCE flow_wildcards_t) (1 << 3))
 130                                               /* excluding the multicast bit */
 131 #define FWW_DL_TYPE     ((OVS_FORCE flow_wildcards_t) (1 << 4))
 132 #define FWW_NW_PROTO    ((OVS_FORCE flow_wildcards_t) (1 << 5))
 133 #define FWW_TP_SRC      ((OVS_FORCE flow_wildcards_t) (1 << 6))
 134 #define FWW_TP_DST      ((OVS_FORCE flow_wildcards_t) (1 << 7))
 135 /* No corresponding OFPFW_* bits. */
 136 #define FWW_ETH_MCAST   ((OVS_FORCE flow_wildcards_t) (1 << 1))
 137                                                        /* multicast bit only */
 138 #define FWW_ARP_SHA     ((OVS_FORCE flow_wildcards_t) (1 << 8))
 139 #define FWW_ARP_THA     ((OVS_FORCE flow_wildcards_t) (1 << 9))
 140 #define FWW_ND_TARGET   ((OVS_FORCE flow_wildcards_t) (1 << 10))
 141 #define FWW_ALL         ((OVS_FORCE flow_wildcards_t) (((1 << 11)) - 1))
 142
 143 /* Remember to update FLOW_WC_SEQ when adding or removing FWW_*. */
 144 BUILD_ASSERT_DECL(FWW_ALL == ((1 << 11) - 1) && FLOW_WC_SEQ == 3);
 145
 146 /* Information on wildcards for a flow, as a supplement to "struct flow".
 147  *
 148  * Note that the meaning of 1-bits in 'wildcards' is opposite that of 1-bits in
 149  * the rest of the members. */
 150 struct flow_wildcards {
 151     ovs_be64 tun_id_mask;       /* 1-bit in each significant tun_id bit. */
 152     flow_wildcards_t wildcards; /* 1-bit in each FWW_* wildcarded field. */
 153     uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */
 154     ovs_be32 nw_src_mask;       /* 1-bit in each significant nw_src bit. */
 155     ovs_be32 nw_dst_mask;       /* 1-bit in each significant nw_dst bit. */
 156     struct in6_addr ipv6_src_mask; /* 1-bit in each signficant ipv6_src bit. */
 157     struct in6_addr ipv6_dst_mask; /* 1-bit in each signficant ipv6_dst bit. */
 158     ovs_be16 vlan_tci_mask;     /* 1-bit in each significant vlan_tci bit. */
 159     uint8_t tos_frag_mask;      /* 1-bit in each significant tos_frag bit. */
 160     uint8_t zeros[5];           /* Padding field set to zero. */
 161 };
 162
 163 /* Remember to update FLOW_WC_SEQ when updating struct flow_wildcards. */
 164 BUILD_ASSERT_DECL(sizeof(struct flow_wildcards) == 80 && FLOW_WC_SEQ == 3);
 165
 166 void flow_wildcards_init_catchall(struct flow_wildcards *);
 167 void flow_wildcards_init_exact(struct flow_wildcards *);
 168
 169 bool flow_wildcards_is_exact(const struct flow_wildcards *);
 170 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
 171
 172 bool flow_wildcards_set_nw_src_mask(struct flow_wildcards *, ovs_be32);
 173 bool flow_wildcards_set_nw_dst_mask(struct flow_wildcards *, ovs_be32);
 174 bool flow_wildcards_set_ipv6_src_mask(struct flow_wildcards *,
 175                                       const struct in6_addr *);
 176 bool flow_wildcards_set_ipv6_dst_mask(struct flow_wildcards *,
 177                                       const struct in6_addr *);
 178 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
 179                                  int idx, uint32_t mask);
 180
 181 void flow_wildcards_combine(struct flow_wildcards *dst,
 182                             const struct flow_wildcards *src1,
 183                             const struct flow_wildcards *src2);
 184 bool flow_wildcards_has_extra(const struct flow_wildcards *,
 185                               const struct flow_wildcards *);
 186
 187 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
 188 bool flow_wildcards_equal(const struct flow_wildcards *,
 189                           const struct flow_wildcards *);
 190 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
 191
 192 const uint8_t *flow_wildcards_to_dl_dst_mask(flow_wildcards_t);
 193 bool flow_wildcards_is_dl_dst_mask_valid(const uint8_t[6]);
 194 flow_wildcards_t flow_wildcards_set_dl_dst_mask(flow_wildcards_t,
 195                                                 const uint8_t mask[6]);
 196 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
 197                           uint16_t basis);
 198 const char *flow_hash_fields_to_str(enum nx_hash_fields);
 199 bool flow_hash_fields_valid(enum nx_hash_fields);
 200
 201 #endif /* flow.h */