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 17
  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 zeros[2];           /* Must be zero. */
  79 };
  80 BUILD_ASSERT_DECL(sizeof(struct flow) % 8 == 0);
  81
  82 #define FLOW_U32S (sizeof(struct flow) / 4)
  83
  84 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
  85 BUILD_ASSERT_DECL(sizeof(struct flow) == 152 && FLOW_WC_SEQ == 17);
  86
  87 /* Represents the metadata fields of struct flow. */
  88 struct flow_metadata {
  89     ovs_be64 tun_id;                 /* Encapsulating tunnel ID. */
  90     ovs_be64 metadata;               /* OpenFlow 1.1+ metadata field. */
  91     uint32_t regs[FLOW_N_REGS];      /* Registers. */
  92     uint16_t in_port;                /* OpenFlow port or zero. */
  93 };
  94
  95 void flow_extract(struct ofpbuf *, uint32_t priority, ovs_be64 tun_id,
  96                   uint16_t in_port, struct flow *);
  97 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
  98 void flow_get_metadata(const struct flow *, struct flow_metadata *);
  99
 100 char *flow_to_string(const struct flow *);
 101 void flow_format(struct ds *, const struct flow *);
 102 void flow_print(FILE *, const struct flow *);
 103 static inline int flow_compare_3way(const struct flow *, const struct flow *);
 104 static inline bool flow_equal(const struct flow *, const struct flow *);
 105 static inline size_t flow_hash(const struct flow *, uint32_t basis);
 106
 107 void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
 108 void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
 109 void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
 110
 111 void flow_compose(struct ofpbuf *, const struct flow *);
 112
 113 static inline int
 114 flow_compare_3way(const struct flow *a, const struct flow *b)
 115 {
 116     return memcmp(a, b, sizeof *a);
 117 }
 118
 119 static inline bool
 120 flow_equal(const struct flow *a, const struct flow *b)
 121 {
 122     return !flow_compare_3way(a, b);
 123 }
 124
 125 static inline size_t
 126 flow_hash(const struct flow *flow, uint32_t basis)
 127 {
 128     return hash_words((const uint32_t *) flow, sizeof *flow / 4, basis);
 129 }
 130 \f
 131 /* Wildcards for a flow.
 132  *
 133  * A 1-bit in each bit in 'masks' indicates that the corresponding bit of
 134  * the flow is significant (must match).  A 0-bit indicates that the
 135  * corresponding bit of the flow is wildcarded (need not match). */
 136 struct flow_wildcards {
 137     struct flow masks;
 138 };
 139
 140 void flow_wildcards_init_catchall(struct flow_wildcards *);
 141 void flow_wildcards_init_exact(struct flow_wildcards *);
 142
 143 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
 144
 145 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
 146                                  int idx, uint32_t mask);
 147
 148 void flow_wildcards_combine(struct flow_wildcards *dst,
 149                             const struct flow_wildcards *src1,
 150                             const struct flow_wildcards *src2);
 151 bool flow_wildcards_has_extra(const struct flow_wildcards *,
 152                               const struct flow_wildcards *);
 153
 154 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
 155 bool flow_wildcards_equal(const struct flow_wildcards *,
 156                           const struct flow_wildcards *);
 157 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
 158
 159 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
 160                           uint16_t basis);
 161 const char *flow_hash_fields_to_str(enum nx_hash_fields);
 162 bool flow_hash_fields_valid(enum nx_hash_fields);
 163
 164 bool flow_equal_except(const struct flow *a, const struct flow *b,
 165                        const struct flow_wildcards *);
 166
 167 #endif /* flow.h */