]>
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 | ||
30 | struct ds; | |
b63f2ea7 | 31 | struct flow_wildcards; |
064af421 BP |
32 | struct ofp_match; |
33 | struct ofpbuf; | |
34 | ||
e468fe85 | 35 | #define FLOW_N_REGS 4 |
b6c9e612 BP |
36 | BUILD_ASSERT_DECL(FLOW_N_REGS <= NXM_NX_MAX_REGS); |
37 | ||
14608a15 | 38 | struct flow { |
b9298d3f | 39 | ovs_be64 tun_id; /* Encapsulating tunnel ID. */ |
b6c9e612 | 40 | uint32_t regs[FLOW_N_REGS]; /* Registers. */ |
0b3e77bb BP |
41 | ovs_be32 nw_src; /* IP source address. */ |
42 | ovs_be32 nw_dst; /* IP destination address. */ | |
14608a15 | 43 | uint16_t in_port; /* Input switch port. */ |
66642cb4 | 44 | ovs_be16 vlan_tci; /* If 802.1Q, TCI | VLAN_CFI; otherwise 0. */ |
0b3e77bb BP |
45 | ovs_be16 dl_type; /* Ethernet frame type. */ |
46 | ovs_be16 tp_src; /* TCP/UDP source port. */ | |
47 | ovs_be16 tp_dst; /* TCP/UDP destination port. */ | |
14608a15 BP |
48 | uint8_t dl_src[6]; /* Ethernet source address. */ |
49 | uint8_t dl_dst[6]; /* Ethernet destination address. */ | |
50 | uint8_t nw_proto; /* IP protocol or low 8 bits of ARP opcode. */ | |
14608a15 BP |
51 | uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */ |
52 | }; | |
53 | ||
54 | /* Assert that there are FLOW_SIG_SIZE bytes of significant data in "struct | |
55 | * flow", followed by FLOW_PAD_SIZE bytes of padding. */ | |
b9298d3f | 56 | #define FLOW_SIG_SIZE (40 + FLOW_N_REGS * 4) |
e468fe85 | 57 | #define FLOW_PAD_SIZE 0 |
14608a15 BP |
58 | BUILD_ASSERT_DECL(offsetof(struct flow, nw_tos) == FLOW_SIG_SIZE - 1); |
59 | BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->nw_tos) == 1); | |
60 | BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE); | |
064af421 | 61 | |
b9298d3f | 62 | int flow_extract(struct ofpbuf *, uint64_t tun_id, uint16_t in_port, |
ae412e7d BP |
63 | struct flow *); |
64 | void flow_extract_stats(const struct flow *flow, struct ofpbuf *packet, | |
064af421 | 65 | struct odp_flow_stats *stats); |
ae412e7d BP |
66 | char *flow_to_string(const struct flow *); |
67 | void flow_format(struct ds *, const struct flow *); | |
68 | void flow_print(FILE *, const struct flow *); | |
69 | static inline int flow_compare(const struct flow *, const struct flow *); | |
70 | static inline bool flow_equal(const struct flow *, const struct flow *); | |
71 | static inline size_t flow_hash(const struct flow *, uint32_t basis); | |
064af421 BP |
72 | |
73 | static inline int | |
ae412e7d | 74 | flow_compare(const struct flow *a, const struct flow *b) |
064af421 | 75 | { |
14608a15 | 76 | return memcmp(a, b, FLOW_SIG_SIZE); |
064af421 BP |
77 | } |
78 | ||
79 | static inline bool | |
ae412e7d | 80 | flow_equal(const struct flow *a, const struct flow *b) |
064af421 BP |
81 | { |
82 | return !flow_compare(a, b); | |
83 | } | |
84 | ||
85 | static inline size_t | |
ae412e7d | 86 | flow_hash(const struct flow *flow, uint32_t basis) |
064af421 | 87 | { |
14608a15 | 88 | return hash_bytes(flow, FLOW_SIG_SIZE, basis); |
064af421 BP |
89 | } |
90 | ||
d8ae4d67 | 91 | /* Open vSwitch flow wildcard bits. |
b6c9e612 | 92 | * |
1e37a2d7 BP |
93 | * These are used only internally to Open vSwitch, in the 'wildcards' member of |
94 | * struct flow_wildcards. They never appear in the wire protocol in this | |
95 | * form. */ | |
96 | ||
d8ae4d67 BP |
97 | typedef unsigned int OVS_BITWISE flow_wildcards_t; |
98 | ||
99 | /* Same values and meanings as corresponding OFPFW_* bits. */ | |
100 | #define FWW_IN_PORT ((OVS_FORCE flow_wildcards_t) (1 << 0)) | |
d8ae4d67 BP |
101 | #define FWW_DL_SRC ((OVS_FORCE flow_wildcards_t) (1 << 2)) |
102 | #define FWW_DL_DST ((OVS_FORCE flow_wildcards_t) (1 << 3)) | |
103 | /* excluding the multicast bit */ | |
104 | #define FWW_DL_TYPE ((OVS_FORCE flow_wildcards_t) (1 << 4)) | |
105 | #define FWW_NW_PROTO ((OVS_FORCE flow_wildcards_t) (1 << 5)) | |
106 | #define FWW_TP_SRC ((OVS_FORCE flow_wildcards_t) (1 << 6)) | |
107 | #define FWW_TP_DST ((OVS_FORCE flow_wildcards_t) (1 << 7)) | |
108 | /* Same meanings as corresponding OFPFW_* bits, but differ in value. */ | |
66642cb4 | 109 | #define FWW_NW_TOS ((OVS_FORCE flow_wildcards_t) (1 << 1)) |
d8ae4d67 | 110 | /* No corresponding OFPFW_* or OVSFW_* bits. */ |
8368c090 | 111 | #define FWW_ETH_MCAST ((OVS_FORCE flow_wildcards_t) (1 << 8)) |
d8ae4d67 | 112 | /* multicast bit only */ |
8368c090 | 113 | #define FWW_ALL ((OVS_FORCE flow_wildcards_t) (((1 << 9)) - 1)) |
b6c9e612 | 114 | |
b5d97350 BP |
115 | /* Information on wildcards for a flow, as a supplement to "struct flow". |
116 | * | |
d8ae4d67 BP |
117 | * Note that the meaning of 1-bits in 'wildcards' is opposite that of 1-bits in |
118 | * the rest of the members. */ | |
064af421 | 119 | struct flow_wildcards { |
8368c090 | 120 | ovs_be64 tun_id_mask; /* 1-bit in each significant tun_id bit. */ |
d8ae4d67 | 121 | flow_wildcards_t wildcards; /* 1-bit in each FWW_* wildcarded field. */ |
b6c9e612 | 122 | uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */ |
0b3e77bb BP |
123 | ovs_be32 nw_src_mask; /* 1-bit in each significant nw_src bit. */ |
124 | ovs_be32 nw_dst_mask; /* 1-bit in each significant nw_dst bit. */ | |
66642cb4 | 125 | ovs_be16 vlan_tci_mask; /* 1-bit in each significant vlan_tci bit. */ |
29b639ed | 126 | uint16_t zero; /* Padding field set to zero. */ |
064af421 BP |
127 | }; |
128 | ||
d8ae4d67 | 129 | void flow_wildcards_init_catchall(struct flow_wildcards *); |
494e43a5 BP |
130 | void flow_wildcards_init_exact(struct flow_wildcards *); |
131 | ||
00561f41 BP |
132 | bool flow_wildcards_is_exact(const struct flow_wildcards *); |
133 | ||
494e43a5 BP |
134 | bool flow_wildcards_set_nw_src_mask(struct flow_wildcards *, ovs_be32); |
135 | bool flow_wildcards_set_nw_dst_mask(struct flow_wildcards *, ovs_be32); | |
b6c9e612 BP |
136 | void flow_wildcards_set_reg_mask(struct flow_wildcards *, |
137 | int idx, uint32_t mask); | |
064af421 | 138 | |
b5d97350 BP |
139 | void flow_wildcards_combine(struct flow_wildcards *dst, |
140 | const struct flow_wildcards *src1, | |
141 | const struct flow_wildcards *src2); | |
142 | bool flow_wildcards_has_extra(const struct flow_wildcards *, | |
143 | const struct flow_wildcards *); | |
144 | ||
145 | uint32_t flow_wildcards_hash(const struct flow_wildcards *); | |
146 | bool flow_wildcards_equal(const struct flow_wildcards *, | |
147 | const struct flow_wildcards *); | |
148 | ||
064af421 | 149 | #endif /* flow.h */ |