]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
e0edde6f | 2 | * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc. |
064af421 | 3 | * |
a14bc59f BP |
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: | |
064af421 | 7 | * |
a14bc59f BP |
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. | |
064af421 BP |
15 | */ |
16 | #ifndef FLOW_H | |
17 | #define FLOW_H 1 | |
18 | ||
7f3adc00 | 19 | #include <sys/types.h> |
064af421 BP |
20 | #include <netinet/in.h> |
21 | #include <stdbool.h> | |
22 | #include <stdint.h> | |
23 | #include <string.h> | |
659586ef | 24 | #include "openflow/nicira-ext.h" |
064af421 BP |
25 | #include "openflow/openflow.h" |
26 | #include "hash.h" | |
064af421 BP |
27 | #include "util.h" |
28 | ||
c97fb132 | 29 | struct dpif_flow_stats; |
064af421 | 30 | struct ds; |
b63f2ea7 | 31 | struct flow_wildcards; |
064af421 BP |
32 | struct ofpbuf; |
33 | ||
a877206f EJ |
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. */ | |
e2170cff | 37 | #define FLOW_WC_SEQ 17 |
a877206f | 38 | |
e9358af6 | 39 | #define FLOW_N_REGS 8 |
b6c9e612 BP |
40 | BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS); |
41 | ||
36956a7d BP |
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 | ||
7257b535 | 46 | /* Fragment bits, used for IPv4 and IPv6, always zero for non-IP flows. */ |
eadef313 JP |
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) | |
7257b535 | 50 | |
eadef313 JP |
51 | BUILD_ASSERT_DECL(FLOW_NW_FRAG_ANY == NX_IP_FRAG_ANY); |
52 | BUILD_ASSERT_DECL(FLOW_NW_FRAG_LATER == NX_IP_FRAG_LATER); | |
7257b535 | 53 | |
14608a15 | 54 | struct flow { |
b9298d3f | 55 | ovs_be64 tun_id; /* Encapsulating tunnel ID. */ |
969fc56c | 56 | ovs_be64 metadata; /* OpenFlow Metadata. */ |
5145475f JP |
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. */ | |
deedf7e7 | 60 | uint32_t skb_priority; /* Packet priority for QoS. */ |
b6c9e612 | 61 | uint32_t regs[FLOW_N_REGS]; /* Registers. */ |
d31f1109 JP |
62 | ovs_be32 nw_src; /* IPv4 source address. */ |
63 | ovs_be32 nw_dst; /* IPv4 destination address. */ | |
fa8223b7 | 64 | ovs_be32 ipv6_label; /* IPv6 flow label. */ |
abe529af | 65 | uint16_t in_port; /* OpenFlow port number of input port. */ |
66642cb4 | 66 | ovs_be16 vlan_tci; /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */ |
0b3e77bb BP |
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. */ | |
14608a15 BP |
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. */ | |
eadef313 | 73 | uint8_t nw_tos; /* IP ToS (including DSCP and ECN). */ |
685a51a5 JP |
74 | uint8_t arp_sha[6]; /* ARP/ND source hardware address. */ |
75 | uint8_t arp_tha[6]; /* ARP/ND target hardware address. */ | |
a61680c6 | 76 | uint8_t nw_ttl; /* IP TTL/Hop Limit. */ |
eadef313 | 77 | uint8_t nw_frag; /* FLOW_FRAG_* flags. */ |
51c14ddd | 78 | uint8_t zeros[2]; /* Must be zero. */ |
14608a15 BP |
79 | }; |
80 | ||
42edbe39 | 81 | /* Represents the metadata fields of struct flow. */ |
5d6c3af0 EJ |
82 | struct flow_metadata { |
83 | ovs_be64 tun_id; /* Encapsulating tunnel ID. */ | |
42edbe39 | 84 | ovs_be64 metadata; /* OpenFlow 1.1+ metadata field. */ |
5d6c3af0 | 85 | uint32_t regs[FLOW_N_REGS]; /* Registers. */ |
5d6c3af0 EJ |
86 | uint16_t in_port; /* OpenFlow port or zero. */ |
87 | }; | |
88 | ||
14608a15 BP |
89 | /* Assert that there are FLOW_SIG_SIZE bytes of significant data in "struct |
90 | * flow", followed by FLOW_PAD_SIZE bytes of padding. */ | |
969fc56c | 91 | #define FLOW_SIG_SIZE (118 + FLOW_N_REGS * 4) |
e9358af6 | 92 | #define FLOW_PAD_SIZE 2 |
eadef313 JP |
93 | BUILD_ASSERT_DECL(offsetof(struct flow, nw_frag) == FLOW_SIG_SIZE - 1); |
94 | BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->nw_frag) == 1); | |
14608a15 | 95 | BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE); |
064af421 | 96 | |
a877206f | 97 | /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */ |
e2170cff | 98 | BUILD_ASSERT_DECL(FLOW_SIG_SIZE == 150 && FLOW_WC_SEQ == 17); |
a877206f | 99 | |
abff858b PS |
100 | void flow_extract(struct ofpbuf *, uint32_t priority, ovs_be64 tun_id, |
101 | uint16_t in_port, struct flow *); | |
993410fb | 102 | void flow_zero_wildcards(struct flow *, const struct flow_wildcards *); |
5d6c3af0 | 103 | void flow_get_metadata(const struct flow *, struct flow_metadata *); |
993410fb | 104 | |
ae412e7d BP |
105 | char *flow_to_string(const struct flow *); |
106 | void flow_format(struct ds *, const struct flow *); | |
107 | void flow_print(FILE *, const struct flow *); | |
79049a24 | 108 | static inline int flow_compare_3way(const struct flow *, const struct flow *); |
ae412e7d BP |
109 | static inline bool flow_equal(const struct flow *, const struct flow *); |
110 | static inline size_t flow_hash(const struct flow *, uint32_t basis); | |
064af421 | 111 | |
fb0451d9 | 112 | void flow_set_dl_vlan(struct flow *, ovs_be16 vid); |
cc34bc8c | 113 | void flow_set_vlan_vid(struct flow *, ovs_be16 vid); |
3719455c BP |
114 | void flow_set_vlan_pcp(struct flow *, uint8_t pcp); |
115 | ||
8b3b8dd1 BP |
116 | void flow_compose(struct ofpbuf *, const struct flow *); |
117 | ||
064af421 | 118 | static inline int |
79049a24 | 119 | flow_compare_3way(const struct flow *a, const struct flow *b) |
064af421 | 120 | { |
14608a15 | 121 | return memcmp(a, b, FLOW_SIG_SIZE); |
064af421 BP |
122 | } |
123 | ||
124 | static inline bool | |
ae412e7d | 125 | flow_equal(const struct flow *a, const struct flow *b) |
064af421 | 126 | { |
79049a24 | 127 | return !flow_compare_3way(a, b); |
064af421 BP |
128 | } |
129 | ||
130 | static inline size_t | |
ae412e7d | 131 | flow_hash(const struct flow *flow, uint32_t basis) |
064af421 | 132 | { |
14608a15 | 133 | return hash_bytes(flow, FLOW_SIG_SIZE, basis); |
064af421 BP |
134 | } |
135 | ||
0bdc4bec | 136 | /* Information on wildcards for a flow, as a supplement to "struct flow". */ |
064af421 | 137 | struct flow_wildcards { |
8368c090 | 138 | ovs_be64 tun_id_mask; /* 1-bit in each significant tun_id bit. */ |
969fc56c | 139 | ovs_be64 metadata_mask; /* 1-bit in each significant metadata bit. */ |
b6c9e612 | 140 | uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */ |
0b3e77bb BP |
141 | ovs_be32 nw_src_mask; /* 1-bit in each significant nw_src bit. */ |
142 | ovs_be32 nw_dst_mask; /* 1-bit in each significant nw_dst bit. */ | |
d31f1109 JP |
143 | struct in6_addr ipv6_src_mask; /* 1-bit in each signficant ipv6_src bit. */ |
144 | struct in6_addr ipv6_dst_mask; /* 1-bit in each signficant ipv6_dst bit. */ | |
47284b1f AA |
145 | struct in6_addr nd_target_mask; /* 1-bit in each significant |
146 | nd_target bit. */ | |
32455024 | 147 | ovs_be32 ipv6_label_mask; /* 1 bit in each significant ipv6_label bit. */ |
0bdc4bec | 148 | uint16_t in_port_mask; /* 1-bit in each significant in_port bit. */ |
66642cb4 | 149 | ovs_be16 vlan_tci_mask; /* 1-bit in each significant vlan_tci bit. */ |
e2170cff | 150 | ovs_be16 dl_type_mask; /* 1-bit in each significant dl_type bit. */ |
73f33563 BP |
151 | ovs_be16 tp_src_mask; /* 1-bit in each significant tp_src bit. */ |
152 | ovs_be16 tp_dst_mask; /* 1-bit in each significant tp_dst bit. */ | |
851d3105 | 153 | uint8_t nw_proto_mask; /* 1-bit in each significant nw_proto bit. */ |
eadef313 | 154 | uint8_t nw_frag_mask; /* 1-bit in each significant nw_frag bit. */ |
73c0ce34 JS |
155 | uint8_t dl_src_mask[6]; /* 1-bit in each significant dl_src bit. */ |
156 | uint8_t dl_dst_mask[6]; /* 1-bit in each significant dl_dst bit. */ | |
e878338b SH |
157 | uint8_t arp_sha_mask[6]; /* 1-bit in each significant dl_dst bit. */ |
158 | uint8_t arp_tha_mask[6]; /* 1-bit in each significant dl_dst bit. */ | |
5d9499c4 | 159 | uint8_t nw_tos_mask; /* 1-bit in each significant nw_tos bit. */ |
3840c406 | 160 | uint8_t nw_ttl_mask; /* 1-bit in each significant nw_ttl bit. */ |
0bdc4bec | 161 | uint8_t zeros[6]; /* Padding field set to zero. */ |
064af421 BP |
162 | }; |
163 | ||
a877206f | 164 | /* Remember to update FLOW_WC_SEQ when updating struct flow_wildcards. */ |
e2170cff | 165 | BUILD_ASSERT_DECL(sizeof(struct flow_wildcards) == 152 && FLOW_WC_SEQ == 17); |
a877206f | 166 | |
d8ae4d67 | 167 | void flow_wildcards_init_catchall(struct flow_wildcards *); |
494e43a5 BP |
168 | void flow_wildcards_init_exact(struct flow_wildcards *); |
169 | ||
00561f41 | 170 | bool flow_wildcards_is_exact(const struct flow_wildcards *); |
ecf1e7ac | 171 | bool flow_wildcards_is_catchall(const struct flow_wildcards *); |
00561f41 | 172 | |
b6c9e612 BP |
173 | void flow_wildcards_set_reg_mask(struct flow_wildcards *, |
174 | int idx, uint32_t mask); | |
064af421 | 175 | |
b5d97350 BP |
176 | void flow_wildcards_combine(struct flow_wildcards *dst, |
177 | const struct flow_wildcards *src1, | |
178 | const struct flow_wildcards *src2); | |
179 | bool flow_wildcards_has_extra(const struct flow_wildcards *, | |
180 | const struct flow_wildcards *); | |
181 | ||
1006cda6 | 182 | uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis); |
b5d97350 BP |
183 | bool flow_wildcards_equal(const struct flow_wildcards *, |
184 | const struct flow_wildcards *); | |
ff55ea1f | 185 | uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis); |
b5d97350 | 186 | |
520e9a2a EJ |
187 | uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields, |
188 | uint16_t basis); | |
189 | const char *flow_hash_fields_to_str(enum nx_hash_fields); | |
190 | bool flow_hash_fields_valid(enum nx_hash_fields); | |
db7f8281 | 191 | |
064af421 | 192 | #endif /* flow.h */ |