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 ofpbuf;
  33
  34 /* This sequence number should be incremented whenever anything involving flows
  35  * or the wildcarding of flows changes.  This will cause build assertion
  36  * failures in places which likely need to be updated. */
  37 #define FLOW_WC_SEQ 14
  38
  39 #define FLOW_N_REGS 8
  40 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
  41
  42 /* Used for struct flow's dl_type member for frames that have no Ethernet
  43  * type, that is, pure 802.2 frames. */
  44 #define FLOW_DL_TYPE_NONE 0x5ff
  45
  46 /* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */
  47 #define FLOW_NW_FRAG_ANY   (1 << 0) /* Set for any IP frag. */
  48 #define FLOW_NW_FRAG_LATER (1 << 1) /* Set for IP frag with nonzero offset. */
  49 #define FLOW_NW_FRAG_MASK  (FLOW_NW_FRAG_ANY | FLOW_NW_FRAG_LATER)
  50
  51 BUILD_ASSERT_DECL(FLOW_NW_FRAG_ANY == NX_IP_FRAG_ANY);
  52 BUILD_ASSERT_DECL(FLOW_NW_FRAG_LATER == NX_IP_FRAG_LATER);
  53
  54 struct flow {
  55     ovs_be64 tun_id;            /* Encapsulating tunnel ID. */
  56     ovs_be64 metadata;          /* OpenFlow Metadata. */
  57     struct in6_addr ipv6_src;   /* IPv6 source address. */
  58     struct in6_addr ipv6_dst;   /* IPv6 destination address. */
  59     struct in6_addr nd_target;  /* IPv6 neighbor discovery (ND) target. */
  60     uint32_t skb_priority;      /* Packet priority for QoS. */
  61     uint32_t regs[FLOW_N_REGS]; /* Registers. */
  62     ovs_be32 nw_src;            /* IPv4 source address. */
  63     ovs_be32 nw_dst;            /* IPv4 destination address. */
  64     ovs_be32 ipv6_label;        /* IPv6 flow label. */
  65     uint16_t in_port;           /* OpenFlow port number of input port. */
  66     ovs_be16 vlan_tci;          /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
  67     ovs_be16 dl_type;           /* Ethernet frame type. */
  68     ovs_be16 tp_src;            /* TCP/UDP source port. */
  69     ovs_be16 tp_dst;            /* TCP/UDP destination port. */
  70     uint8_t dl_src[6];          /* Ethernet source address. */
  71     uint8_t dl_dst[6];          /* Ethernet destination address. */
  72     uint8_t nw_proto;           /* IP protocol or low 8 bits of ARP opcode. */
  73     uint8_t nw_tos;             /* IP ToS (including DSCP and ECN). */
  74     uint8_t arp_sha[6];         /* ARP/ND source hardware address. */
  75     uint8_t arp_tha[6];         /* ARP/ND target hardware address. */
  76     uint8_t nw_ttl;             /* IP TTL/Hop Limit. */
  77     uint8_t nw_frag;            /* FLOW_FRAG_* flags. */
  78     uint8_t reserved[2];        /* Reserved for 64-bit packing. */
  79 };
  80
  81 /* Represents the metadata fields of struct flow.  The masks are used to
  82  * indicate which metadata fields are relevant in a given context.  Typically
  83  * they will be all 1 or all 0. */
  84 struct flow_metadata {
  85     ovs_be64 tun_id;                 /* Encapsulating tunnel ID. */
  86     ovs_be64 tun_id_mask;            /* 1-bit in each significant tun_id bit.*/
  87
  88     ovs_be64 metadata;
  89     ovs_be64 metadata_mask;
  90
  91     uint32_t regs[FLOW_N_REGS];      /* Registers. */
  92     uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */
  93
  94     uint16_t in_port;                /* OpenFlow port or zero. */
  95 };
  96
  97 /* Assert that there are FLOW_SIG_SIZE bytes of significant data in "struct
  98  * flow", followed by FLOW_PAD_SIZE bytes of padding. */
  99 #define FLOW_SIG_SIZE (118 + FLOW_N_REGS * 4)
 100 #define FLOW_PAD_SIZE 2
 101 BUILD_ASSERT_DECL(offsetof(struct flow, nw_frag) == FLOW_SIG_SIZE - 1);
 102 BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->nw_frag) == 1);
 103 BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE);
 104
 105 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
 106 BUILD_ASSERT_DECL(FLOW_SIG_SIZE == 150 && FLOW_WC_SEQ == 14);
 107
 108 void flow_extract(struct ofpbuf *, uint32_t priority, ovs_be64 tun_id,
 109                   uint16_t in_port, struct flow *);
 110 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
 111 void flow_get_metadata(const struct flow *, struct flow_metadata *);
 112
 113 char *flow_to_string(const struct flow *);
 114 void flow_format(struct ds *, const struct flow *);
 115 void flow_print(FILE *, const struct flow *);
 116 static inline int flow_compare_3way(const struct flow *, const struct flow *);
 117 static inline bool flow_equal(const struct flow *, const struct flow *);
 118 static inline size_t flow_hash(const struct flow *, uint32_t basis);
 119
 120 void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
 121 void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
 122
 123 void flow_compose(struct ofpbuf *, const struct flow *);
 124
 125 static inline int
 126 flow_compare_3way(const struct flow *a, const struct flow *b)
 127 {
 128     return memcmp(a, b, FLOW_SIG_SIZE);
 129 }
 130
 131 static inline bool
 132 flow_equal(const struct flow *a, const struct flow *b)
 133 {
 134     return !flow_compare_3way(a, b);
 135 }
 136
 137 static inline size_t
 138 flow_hash(const struct flow *flow, uint32_t basis)
 139 {
 140     return hash_bytes(flow, FLOW_SIG_SIZE, basis);
 141 }
 142
 143 /* Open vSwitch flow wildcard bits.
 144  *
 145  * These are used only internally to Open vSwitch, in the 'wildcards' member of
 146  * struct flow_wildcards.  They never appear in the wire protocol in this
 147  * form. */
 148
 149 typedef unsigned int OVS_BITWISE flow_wildcards_t;
 150
 151 /* Same values and meanings as corresponding OFPFW10_* bits. */
 152 #define FWW_IN_PORT     ((OVS_FORCE flow_wildcards_t) (1 << 0))
 153 #define FWW_DL_TYPE     ((OVS_FORCE flow_wildcards_t) (1 << 4))
 154 #define FWW_NW_PROTO    ((OVS_FORCE flow_wildcards_t) (1 << 5))
 155 /* No corresponding OFPFW10_* bits. */
 156 #define FWW_NW_DSCP     ((OVS_FORCE flow_wildcards_t) (1 << 1))
 157 #define FWW_NW_ECN      ((OVS_FORCE flow_wildcards_t) (1 << 2))
 158 #define FWW_NW_TTL      ((OVS_FORCE flow_wildcards_t) (1 << 3))
 159 #define FWW_ALL         ((OVS_FORCE flow_wildcards_t) (((1 << 6)) - 1))
 160
 161 /* Remember to update FLOW_WC_SEQ when adding or removing FWW_*. */
 162 BUILD_ASSERT_DECL(FWW_ALL == ((1 << 6) - 1) && FLOW_WC_SEQ == 14);
 163
 164 /* Information on wildcards for a flow, as a supplement to "struct flow".
 165  *
 166  * Note that the meaning of 1-bits in 'wildcards' is opposite that of 1-bits in
 167  * the rest of the members. */
 168 struct flow_wildcards {
 169     ovs_be64 tun_id_mask;       /* 1-bit in each significant tun_id bit. */
 170     ovs_be64 metadata_mask;     /* 1-bit in each significant metadata bit. */
 171     flow_wildcards_t wildcards; /* 1-bit in each FWW_* wildcarded field. */
 172     uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */
 173     ovs_be32 nw_src_mask;       /* 1-bit in each significant nw_src bit. */
 174     ovs_be32 nw_dst_mask;       /* 1-bit in each significant nw_dst bit. */
 175     struct in6_addr ipv6_src_mask; /* 1-bit in each signficant ipv6_src bit. */
 176     struct in6_addr ipv6_dst_mask; /* 1-bit in each signficant ipv6_dst bit. */
 177     struct in6_addr nd_target_mask; /* 1-bit in each significant
 178                                        nd_target bit. */
 179     ovs_be32 ipv6_label_mask;   /* 1 bit in each significant ipv6_label bit. */
 180     ovs_be16 vlan_tci_mask;     /* 1-bit in each significant vlan_tci bit. */
 181     ovs_be16 tp_src_mask;       /* 1-bit in each significant tp_src bit. */
 182     ovs_be16 tp_dst_mask;       /* 1-bit in each significant tp_dst bit. */
 183     uint8_t nw_frag_mask;       /* 1-bit in each significant nw_frag bit. */
 184     uint8_t dl_src_mask[6];     /* 1-bit in each significant dl_src bit. */
 185     uint8_t dl_dst_mask[6];     /* 1-bit in each significant dl_dst bit. */
 186     uint8_t arp_sha_mask[6];    /* 1-bit in each significant dl_dst bit. */
 187     uint8_t arp_tha_mask[6];    /* 1-bit in each significant dl_dst bit. */
 188     uint8_t zeros[1];           /* Padding field set to zero. */
 189 };
 190
 191 /* Remember to update FLOW_WC_SEQ when updating struct flow_wildcards. */
 192 BUILD_ASSERT_DECL(sizeof(struct flow_wildcards) == 144 && FLOW_WC_SEQ == 14);
 193
 194 void flow_wildcards_init_catchall(struct flow_wildcards *);
 195 void flow_wildcards_init_exact(struct flow_wildcards *);
 196
 197 bool flow_wildcards_is_exact(const struct flow_wildcards *);
 198 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
 199
 200 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
 201                                  int idx, uint32_t mask);
 202
 203 void flow_wildcards_combine(struct flow_wildcards *dst,
 204                             const struct flow_wildcards *src1,
 205                             const struct flow_wildcards *src2);
 206 bool flow_wildcards_has_extra(const struct flow_wildcards *,
 207                               const struct flow_wildcards *);
 208
 209 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
 210 bool flow_wildcards_equal(const struct flow_wildcards *,
 211                           const struct flow_wildcards *);
 212 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
 213
 214 const uint8_t *flow_wildcards_to_dl_dst_mask(flow_wildcards_t);
 215 bool flow_wildcards_is_dl_dst_mask_valid(const uint8_t[6]);
 216 flow_wildcards_t flow_wildcards_set_dl_dst_mask(flow_wildcards_t,
 217                                                 const uint8_t mask[6]);
 218 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
 219                           uint16_t basis);
 220 const char *flow_hash_fields_to_str(enum nx_hash_fields);
 221 bool flow_hash_fields_valid(enum nx_hash_fields);
 222
 223 #endif /* flow.h */