2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <sys/types.h>
20 #include <netinet/in.h>
24 #include "openflow/nicira-ext.h"
25 #include "openflow/openflow.h"
27 #include "openvswitch/datapath-protocol.h"
30 struct dpif_flow_stats;
32 struct flow_wildcards;
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. */
42 BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS);
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
49 ovs_be64 tun_id; /* Encapsulating tunnel ID. */
50 uint32_t regs[FLOW_N_REGS]; /* Registers. */
51 ovs_be32 nw_src; /* IPv4 source address. */
52 ovs_be32 nw_dst; /* IPv4 destination address. */
53 uint16_t in_port; /* OpenFlow port number of input port. */
54 ovs_be16 vlan_tci; /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */
55 ovs_be16 dl_type; /* Ethernet frame type. */
56 ovs_be16 tp_src; /* TCP/UDP source port. */
57 ovs_be16 tp_dst; /* TCP/UDP destination port. */
58 uint8_t dl_src[6]; /* Ethernet source address. */
59 uint8_t dl_dst[6]; /* Ethernet destination address. */
60 uint8_t nw_proto; /* IP protocol or low 8 bits of ARP opcode. */
61 uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */
62 uint8_t arp_sha[6]; /* ARP/ND source hardware address. */
63 uint8_t arp_tha[6]; /* ARP/ND target hardware address. */
64 struct in6_addr ipv6_src; /* IPv6 source address. */
65 struct in6_addr ipv6_dst; /* IPv6 destination address. */
66 struct in6_addr nd_target; /* IPv6 neighbor discovery (ND) target. */
67 uint32_t reserved; /* Reserved for 64-bit packing. */
70 /* Assert that there are FLOW_SIG_SIZE bytes of significant data in "struct
71 * flow", followed by FLOW_PAD_SIZE bytes of padding. */
72 #define FLOW_SIG_SIZE (100 + FLOW_N_REGS * 4)
73 #define FLOW_PAD_SIZE 4
74 BUILD_ASSERT_DECL(offsetof(struct flow, nd_target) == FLOW_SIG_SIZE - 16);
75 BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->nd_target) == 16);
76 BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE);
78 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
79 BUILD_ASSERT_DECL(FLOW_SIG_SIZE == 116 && FLOW_WC_SEQ == 1);
81 int flow_extract(struct ofpbuf *, ovs_be64 tun_id, uint16_t in_port,
83 void flow_extract_stats(const struct flow *flow, struct ofpbuf *packet,
84 struct dpif_flow_stats *);
85 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
87 char *flow_to_string(const struct flow *);
88 void flow_format(struct ds *, const struct flow *);
89 void flow_print(FILE *, const struct flow *);
90 static inline int flow_compare(const struct flow *, const struct flow *);
91 static inline bool flow_equal(const struct flow *, const struct flow *);
92 static inline size_t flow_hash(const struct flow *, uint32_t basis);
94 void flow_compose(struct ofpbuf *, const struct flow *);
97 flow_compare(const struct flow *a, const struct flow *b)
99 return memcmp(a, b, FLOW_SIG_SIZE);
103 flow_equal(const struct flow *a, const struct flow *b)
105 return !flow_compare(a, b);
109 flow_hash(const struct flow *flow, uint32_t basis)
111 return hash_bytes(flow, FLOW_SIG_SIZE, basis);
114 /* Open vSwitch flow wildcard bits.
116 * These are used only internally to Open vSwitch, in the 'wildcards' member of
117 * struct flow_wildcards. They never appear in the wire protocol in this
120 typedef unsigned int OVS_BITWISE flow_wildcards_t;
122 /* Same values and meanings as corresponding OFPFW_* bits. */
123 #define FWW_IN_PORT ((OVS_FORCE flow_wildcards_t) (1 << 0))
124 #define FWW_DL_SRC ((OVS_FORCE flow_wildcards_t) (1 << 2))
125 #define FWW_DL_DST ((OVS_FORCE flow_wildcards_t) (1 << 3))
126 /* excluding the multicast bit */
127 #define FWW_DL_TYPE ((OVS_FORCE flow_wildcards_t) (1 << 4))
128 #define FWW_NW_PROTO ((OVS_FORCE flow_wildcards_t) (1 << 5))
129 #define FWW_TP_SRC ((OVS_FORCE flow_wildcards_t) (1 << 6))
130 #define FWW_TP_DST ((OVS_FORCE flow_wildcards_t) (1 << 7))
131 /* Same meanings as corresponding OFPFW_* bits, but differ in value. */
132 #define FWW_NW_TOS ((OVS_FORCE flow_wildcards_t) (1 << 1))
133 /* No corresponding OFPFW_* bits. */
134 #define FWW_ETH_MCAST ((OVS_FORCE flow_wildcards_t) (1 << 8))
135 /* multicast bit only */
136 #define FWW_ARP_SHA ((OVS_FORCE flow_wildcards_t) (1 << 9))
137 #define FWW_ARP_THA ((OVS_FORCE flow_wildcards_t) (1 << 10))
138 #define FWW_ND_TARGET ((OVS_FORCE flow_wildcards_t) (1 << 11))
139 #define FWW_ALL ((OVS_FORCE flow_wildcards_t) (((1 << 12)) - 1))
141 /* Remember to update FLOW_WC_SEQ when adding or removing FWW_*. */
142 BUILD_ASSERT_DECL(FWW_ALL == ((1 << 12) - 1) && FLOW_WC_SEQ == 1);
144 /* Information on wildcards for a flow, as a supplement to "struct flow".
146 * Note that the meaning of 1-bits in 'wildcards' is opposite that of 1-bits in
147 * the rest of the members. */
148 struct flow_wildcards {
149 ovs_be64 tun_id_mask; /* 1-bit in each significant tun_id bit. */
150 flow_wildcards_t wildcards; /* 1-bit in each FWW_* wildcarded field. */
151 uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */
152 ovs_be32 nw_src_mask; /* 1-bit in each significant nw_src bit. */
153 ovs_be32 nw_dst_mask; /* 1-bit in each significant nw_dst bit. */
154 struct in6_addr ipv6_src_mask; /* 1-bit in each signficant ipv6_src bit. */
155 struct in6_addr ipv6_dst_mask; /* 1-bit in each signficant ipv6_dst bit. */
156 ovs_be16 vlan_tci_mask; /* 1-bit in each significant vlan_tci bit. */
157 uint16_t zero; /* Padding field set to zero. */
160 /* Remember to update FLOW_WC_SEQ when updating struct flow_wildcards. */
161 BUILD_ASSERT_DECL(sizeof(struct flow_wildcards) == 72 && FLOW_WC_SEQ == 1);
163 void flow_wildcards_init_catchall(struct flow_wildcards *);
164 void flow_wildcards_init_exact(struct flow_wildcards *);
166 bool flow_wildcards_is_exact(const struct flow_wildcards *);
167 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
169 bool flow_wildcards_set_nw_src_mask(struct flow_wildcards *, ovs_be32);
170 bool flow_wildcards_set_nw_dst_mask(struct flow_wildcards *, ovs_be32);
171 bool flow_wildcards_set_ipv6_src_mask(struct flow_wildcards *,
172 const struct in6_addr *);
173 bool flow_wildcards_set_ipv6_dst_mask(struct flow_wildcards *,
174 const struct in6_addr *);
175 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
176 int idx, uint32_t mask);
178 void flow_wildcards_combine(struct flow_wildcards *dst,
179 const struct flow_wildcards *src1,
180 const struct flow_wildcards *src2);
181 bool flow_wildcards_has_extra(const struct flow_wildcards *,
182 const struct flow_wildcards *);
184 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
185 bool flow_wildcards_equal(const struct flow_wildcards *,
186 const struct flow_wildcards *);
187 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
189 const uint8_t *flow_wildcards_to_dl_dst_mask(flow_wildcards_t);
190 bool flow_wildcards_is_dl_dst_mask_valid(const uint8_t[6]);
191 flow_wildcards_t flow_wildcards_set_dl_dst_mask(flow_wildcards_t,
192 const uint8_t mask[6]);
193 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
195 const char *flow_hash_fields_to_str(enum nx_hash_fields);
196 bool flow_hash_fields_valid(enum nx_hash_fields);