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