]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
8368c090 | 2 | * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks. |
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 "openvswitch/datapath-protocol.h" |
28 | #include "util.h" | |
29 | ||
c97fb132 | 30 | struct dpif_flow_stats; |
064af421 | 31 | struct ds; |
b63f2ea7 | 32 | struct flow_wildcards; |
064af421 BP |
33 | struct ofp_match; |
34 | struct ofpbuf; | |
35 | ||
e468fe85 | 36 | #define FLOW_N_REGS 4 |
b6c9e612 BP |
37 | BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS); |
38 | ||
36956a7d BP |
39 | /* Used for struct flow's dl_type member for frames that have no Ethernet |
40 | * type, that is, pure 802.2 frames. */ | |
41 | #define FLOW_DL_TYPE_NONE 0x5ff | |
42 | ||
14608a15 | 43 | struct flow { |
b9298d3f | 44 | ovs_be64 tun_id; /* Encapsulating tunnel ID. */ |
b6c9e612 | 45 | uint32_t regs[FLOW_N_REGS]; /* Registers. */ |
d31f1109 JP |
46 | ovs_be32 nw_src; /* IPv4 source address. */ |
47 | ovs_be32 nw_dst; /* IPv4 destination address. */ | |
abe529af | 48 | uint16_t in_port; /* OpenFlow port number of input port. */ |
66642cb4 | 49 | ovs_be16 vlan_tci; /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */ |
0b3e77bb BP |
50 | ovs_be16 dl_type; /* Ethernet frame type. */ |
51 | ovs_be16 tp_src; /* TCP/UDP source port. */ | |
52 | ovs_be16 tp_dst; /* TCP/UDP destination port. */ | |
14608a15 BP |
53 | uint8_t dl_src[6]; /* Ethernet source address. */ |
54 | uint8_t dl_dst[6]; /* Ethernet destination address. */ | |
55 | uint8_t nw_proto; /* IP protocol or low 8 bits of ARP opcode. */ | |
14608a15 | 56 | uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */ |
685a51a5 JP |
57 | uint8_t arp_sha[6]; /* ARP/ND source hardware address. */ |
58 | uint8_t arp_tha[6]; /* ARP/ND target hardware address. */ | |
d31f1109 JP |
59 | struct in6_addr ipv6_src; /* IPv6 source address. */ |
60 | struct in6_addr ipv6_dst; /* IPv6 destination address. */ | |
685a51a5 | 61 | struct in6_addr nd_target; /* IPv6 neighbor discovery (ND) target. */ |
bad68a99 | 62 | uint32_t reserved; /* Reserved for 64-bit packing. */ |
14608a15 BP |
63 | }; |
64 | ||
65 | /* Assert that there are FLOW_SIG_SIZE bytes of significant data in "struct | |
66 | * flow", followed by FLOW_PAD_SIZE bytes of padding. */ | |
685a51a5 | 67 | #define FLOW_SIG_SIZE (100 + FLOW_N_REGS * 4) |
bad68a99 | 68 | #define FLOW_PAD_SIZE 4 |
685a51a5 JP |
69 | BUILD_ASSERT_DECL(offsetof(struct flow, nd_target) == FLOW_SIG_SIZE - 16); |
70 | BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->nd_target) == 16); | |
14608a15 | 71 | BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE); |
064af421 | 72 | |
d84d4b88 | 73 | int flow_extract(struct ofpbuf *, ovs_be64 tun_id, uint16_t in_port, |
ae412e7d BP |
74 | struct flow *); |
75 | void flow_extract_stats(const struct flow *flow, struct ofpbuf *packet, | |
c97fb132 | 76 | struct dpif_flow_stats *); |
ae412e7d BP |
77 | char *flow_to_string(const struct flow *); |
78 | void flow_format(struct ds *, const struct flow *); | |
79 | void flow_print(FILE *, const struct flow *); | |
80 | static inline int flow_compare(const struct flow *, const struct flow *); | |
81 | static inline bool flow_equal(const struct flow *, const struct flow *); | |
82 | static inline size_t flow_hash(const struct flow *, uint32_t basis); | |
064af421 BP |
83 | |
84 | static inline int | |
ae412e7d | 85 | flow_compare(const struct flow *a, const struct flow *b) |
064af421 | 86 | { |
14608a15 | 87 | return memcmp(a, b, FLOW_SIG_SIZE); |
064af421 BP |
88 | } |
89 | ||
90 | static inline bool | |
ae412e7d | 91 | flow_equal(const struct flow *a, const struct flow *b) |
064af421 BP |
92 | { |
93 | return !flow_compare(a, b); | |
94 | } | |
95 | ||
96 | static inline size_t | |
ae412e7d | 97 | flow_hash(const struct flow *flow, uint32_t basis) |
064af421 | 98 | { |
14608a15 | 99 | return hash_bytes(flow, FLOW_SIG_SIZE, basis); |
064af421 BP |
100 | } |
101 | ||
d8ae4d67 | 102 | /* Open vSwitch flow wildcard bits. |
b6c9e612 | 103 | * |
1e37a2d7 BP |
104 | * These are used only internally to Open vSwitch, in the 'wildcards' member of |
105 | * struct flow_wildcards. They never appear in the wire protocol in this | |
106 | * form. */ | |
107 | ||
d8ae4d67 BP |
108 | typedef unsigned int OVS_BITWISE flow_wildcards_t; |
109 | ||
110 | /* Same values and meanings as corresponding OFPFW_* bits. */ | |
111 | #define FWW_IN_PORT ((OVS_FORCE flow_wildcards_t) (1 << 0)) | |
d8ae4d67 BP |
112 | #define FWW_DL_SRC ((OVS_FORCE flow_wildcards_t) (1 << 2)) |
113 | #define FWW_DL_DST ((OVS_FORCE flow_wildcards_t) (1 << 3)) | |
114 | /* excluding the multicast bit */ | |
115 | #define FWW_DL_TYPE ((OVS_FORCE flow_wildcards_t) (1 << 4)) | |
116 | #define FWW_NW_PROTO ((OVS_FORCE flow_wildcards_t) (1 << 5)) | |
117 | #define FWW_TP_SRC ((OVS_FORCE flow_wildcards_t) (1 << 6)) | |
118 | #define FWW_TP_DST ((OVS_FORCE flow_wildcards_t) (1 << 7)) | |
119 | /* Same meanings as corresponding OFPFW_* bits, but differ in value. */ | |
66642cb4 | 120 | #define FWW_NW_TOS ((OVS_FORCE flow_wildcards_t) (1 << 1)) |
00794817 | 121 | /* No corresponding OFPFW_* bits. */ |
8368c090 | 122 | #define FWW_ETH_MCAST ((OVS_FORCE flow_wildcards_t) (1 << 8)) |
d8ae4d67 | 123 | /* multicast bit only */ |
bad68a99 JP |
124 | #define FWW_ARP_SHA ((OVS_FORCE flow_wildcards_t) (1 << 9)) |
125 | #define FWW_ARP_THA ((OVS_FORCE flow_wildcards_t) (1 << 10)) | |
685a51a5 JP |
126 | #define FWW_ND_TARGET ((OVS_FORCE flow_wildcards_t) (1 << 11)) |
127 | #define FWW_ALL ((OVS_FORCE flow_wildcards_t) (((1 << 12)) - 1)) | |
b6c9e612 | 128 | |
b5d97350 BP |
129 | /* Information on wildcards for a flow, as a supplement to "struct flow". |
130 | * | |
d8ae4d67 BP |
131 | * Note that the meaning of 1-bits in 'wildcards' is opposite that of 1-bits in |
132 | * the rest of the members. */ | |
064af421 | 133 | struct flow_wildcards { |
8368c090 | 134 | ovs_be64 tun_id_mask; /* 1-bit in each significant tun_id bit. */ |
d8ae4d67 | 135 | flow_wildcards_t wildcards; /* 1-bit in each FWW_* wildcarded field. */ |
b6c9e612 | 136 | uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */ |
0b3e77bb BP |
137 | ovs_be32 nw_src_mask; /* 1-bit in each significant nw_src bit. */ |
138 | ovs_be32 nw_dst_mask; /* 1-bit in each significant nw_dst bit. */ | |
d31f1109 JP |
139 | struct in6_addr ipv6_src_mask; /* 1-bit in each signficant ipv6_src bit. */ |
140 | struct in6_addr ipv6_dst_mask; /* 1-bit in each signficant ipv6_dst bit. */ | |
66642cb4 | 141 | ovs_be16 vlan_tci_mask; /* 1-bit in each significant vlan_tci bit. */ |
29b639ed | 142 | uint16_t zero; /* Padding field set to zero. */ |
064af421 BP |
143 | }; |
144 | ||
d8ae4d67 | 145 | void flow_wildcards_init_catchall(struct flow_wildcards *); |
494e43a5 BP |
146 | void flow_wildcards_init_exact(struct flow_wildcards *); |
147 | ||
00561f41 BP |
148 | bool flow_wildcards_is_exact(const struct flow_wildcards *); |
149 | ||
494e43a5 BP |
150 | bool flow_wildcards_set_nw_src_mask(struct flow_wildcards *, ovs_be32); |
151 | bool flow_wildcards_set_nw_dst_mask(struct flow_wildcards *, ovs_be32); | |
d31f1109 JP |
152 | bool flow_wildcards_set_ipv6_src_mask(struct flow_wildcards *, |
153 | const struct in6_addr *); | |
154 | bool flow_wildcards_set_ipv6_dst_mask(struct flow_wildcards *, | |
155 | const struct in6_addr *); | |
b6c9e612 BP |
156 | void flow_wildcards_set_reg_mask(struct flow_wildcards *, |
157 | int idx, uint32_t mask); | |
064af421 | 158 | |
b5d97350 BP |
159 | void flow_wildcards_combine(struct flow_wildcards *dst, |
160 | const struct flow_wildcards *src1, | |
161 | const struct flow_wildcards *src2); | |
162 | bool flow_wildcards_has_extra(const struct flow_wildcards *, | |
163 | const struct flow_wildcards *); | |
164 | ||
1006cda6 | 165 | uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis); |
b5d97350 BP |
166 | bool flow_wildcards_equal(const struct flow_wildcards *, |
167 | const struct flow_wildcards *); | |
ff55ea1f | 168 | uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis); |
b5d97350 | 169 | |
db7f8281 BP |
170 | const uint8_t *flow_wildcards_to_dl_dst_mask(flow_wildcards_t); |
171 | bool flow_wildcards_is_dl_dst_mask_valid(const uint8_t[6]); | |
172 | flow_wildcards_t flow_wildcards_set_dl_dst_mask(flow_wildcards_t, | |
173 | const uint8_t mask[6]); | |
174 | ||
064af421 | 175 | #endif /* flow.h */ |