ofp-msgs: Split OFPRAW_OFPST_AGGREGATE_REQUEST
[sliver-openvswitch.git] / 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 14
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 reserved[2];        /* Reserved for 64-bit packing. */
79 };
80
81 /* Represents the metadata fields of struct flow. */
82 struct flow_metadata {
83     ovs_be64 tun_id;                 /* Encapsulating tunnel ID. */
84     ovs_be64 metadata;               /* OpenFlow 1.1+ metadata field. */
85     uint32_t regs[FLOW_N_REGS];      /* Registers. */
86     uint16_t in_port;                /* OpenFlow port or zero. */
87 };
88
89 /* Assert that there are FLOW_SIG_SIZE bytes of significant data in "struct
90  * flow", followed by FLOW_PAD_SIZE bytes of padding. */
91 #define FLOW_SIG_SIZE (118 + FLOW_N_REGS * 4)
92 #define FLOW_PAD_SIZE 2
93 BUILD_ASSERT_DECL(offsetof(struct flow, nw_frag) == FLOW_SIG_SIZE - 1);
94 BUILD_ASSERT_DECL(sizeof(((struct flow *)0)->nw_frag) == 1);
95 BUILD_ASSERT_DECL(sizeof(struct flow) == FLOW_SIG_SIZE + FLOW_PAD_SIZE);
96
97 /* Remember to update FLOW_WC_SEQ when changing 'struct flow'. */
98 BUILD_ASSERT_DECL(FLOW_SIG_SIZE == 150 && FLOW_WC_SEQ == 14);
99
100 void flow_extract(struct ofpbuf *, uint32_t priority, ovs_be64 tun_id,
101                   uint16_t in_port, struct flow *);
102 void flow_zero_wildcards(struct flow *, const struct flow_wildcards *);
103 void flow_get_metadata(const struct flow *, struct flow_metadata *);
104
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 *);
108 static inline int flow_compare_3way(const struct flow *, const struct flow *);
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);
111
112 void flow_set_dl_vlan(struct flow *, ovs_be16 vid);
113 void flow_set_vlan_vid(struct flow *, ovs_be16 vid);
114 void flow_set_vlan_pcp(struct flow *, uint8_t pcp);
115
116 void flow_compose(struct ofpbuf *, const struct flow *);
117
118 static inline int
119 flow_compare_3way(const struct flow *a, const struct flow *b)
120 {
121     return memcmp(a, b, FLOW_SIG_SIZE);
122 }
123
124 static inline bool
125 flow_equal(const struct flow *a, const struct flow *b)
126 {
127     return !flow_compare_3way(a, b);
128 }
129
130 static inline size_t
131 flow_hash(const struct flow *flow, uint32_t basis)
132 {
133     return hash_bytes(flow, FLOW_SIG_SIZE, basis);
134 }
135
136 /* Open vSwitch flow wildcard bits.
137  *
138  * These are used only internally to Open vSwitch, in the 'wildcards' member of
139  * struct flow_wildcards.  They never appear in the wire protocol in this
140  * form. */
141
142 typedef unsigned int OVS_BITWISE flow_wildcards_t;
143
144 /* Same values and meanings as corresponding OFPFW10_* bits. */
145 #define FWW_IN_PORT     ((OVS_FORCE flow_wildcards_t) (1 << 0))
146 #define FWW_DL_TYPE     ((OVS_FORCE flow_wildcards_t) (1 << 4))
147 #define FWW_NW_PROTO    ((OVS_FORCE flow_wildcards_t) (1 << 5))
148 /* No corresponding OFPFW10_* bits. */
149 #define FWW_NW_DSCP     ((OVS_FORCE flow_wildcards_t) (1 << 1))
150 #define FWW_NW_ECN      ((OVS_FORCE flow_wildcards_t) (1 << 2))
151 #define FWW_NW_TTL      ((OVS_FORCE flow_wildcards_t) (1 << 3))
152 #define FWW_ALL         ((OVS_FORCE flow_wildcards_t) (((1 << 6)) - 1))
153
154 /* Remember to update FLOW_WC_SEQ when adding or removing FWW_*. */
155 BUILD_ASSERT_DECL(FWW_ALL == ((1 << 6) - 1) && FLOW_WC_SEQ == 14);
156
157 /* Information on wildcards for a flow, as a supplement to "struct flow".
158  *
159  * Note that the meaning of 1-bits in 'wildcards' is opposite that of 1-bits in
160  * the rest of the members. */
161 struct flow_wildcards {
162     ovs_be64 tun_id_mask;       /* 1-bit in each significant tun_id bit. */
163     ovs_be64 metadata_mask;     /* 1-bit in each significant metadata bit. */
164     flow_wildcards_t wildcards; /* 1-bit in each FWW_* wildcarded field. */
165     uint32_t reg_masks[FLOW_N_REGS]; /* 1-bit in each significant regs bit. */
166     ovs_be32 nw_src_mask;       /* 1-bit in each significant nw_src bit. */
167     ovs_be32 nw_dst_mask;       /* 1-bit in each significant nw_dst bit. */
168     struct in6_addr ipv6_src_mask; /* 1-bit in each signficant ipv6_src bit. */
169     struct in6_addr ipv6_dst_mask; /* 1-bit in each signficant ipv6_dst bit. */
170     struct in6_addr nd_target_mask; /* 1-bit in each significant
171                                        nd_target bit. */
172     ovs_be32 ipv6_label_mask;   /* 1 bit in each significant ipv6_label bit. */
173     ovs_be16 vlan_tci_mask;     /* 1-bit in each significant vlan_tci bit. */
174     ovs_be16 tp_src_mask;       /* 1-bit in each significant tp_src bit. */
175     ovs_be16 tp_dst_mask;       /* 1-bit in each significant tp_dst bit. */
176     uint8_t nw_frag_mask;       /* 1-bit in each significant nw_frag bit. */
177     uint8_t dl_src_mask[6];     /* 1-bit in each significant dl_src bit. */
178     uint8_t dl_dst_mask[6];     /* 1-bit in each significant dl_dst bit. */
179     uint8_t arp_sha_mask[6];    /* 1-bit in each significant dl_dst bit. */
180     uint8_t arp_tha_mask[6];    /* 1-bit in each significant dl_dst bit. */
181     uint8_t zeros[1];           /* Padding field set to zero. */
182 };
183
184 /* Remember to update FLOW_WC_SEQ when updating struct flow_wildcards. */
185 BUILD_ASSERT_DECL(sizeof(struct flow_wildcards) == 144 && FLOW_WC_SEQ == 14);
186
187 void flow_wildcards_init_catchall(struct flow_wildcards *);
188 void flow_wildcards_init_exact(struct flow_wildcards *);
189
190 bool flow_wildcards_is_exact(const struct flow_wildcards *);
191 bool flow_wildcards_is_catchall(const struct flow_wildcards *);
192
193 void flow_wildcards_set_reg_mask(struct flow_wildcards *,
194                                  int idx, uint32_t mask);
195
196 void flow_wildcards_combine(struct flow_wildcards *dst,
197                             const struct flow_wildcards *src1,
198                             const struct flow_wildcards *src2);
199 bool flow_wildcards_has_extra(const struct flow_wildcards *,
200                               const struct flow_wildcards *);
201
202 uint32_t flow_wildcards_hash(const struct flow_wildcards *, uint32_t basis);
203 bool flow_wildcards_equal(const struct flow_wildcards *,
204                           const struct flow_wildcards *);
205 uint32_t flow_hash_symmetric_l4(const struct flow *flow, uint32_t basis);
206
207 const uint8_t *flow_wildcards_to_dl_dst_mask(flow_wildcards_t);
208 bool flow_wildcards_is_dl_dst_mask_valid(const uint8_t[6]);
209 flow_wildcards_t flow_wildcards_set_dl_dst_mask(flow_wildcards_t,
210                                                 const uint8_t mask[6]);
211 uint32_t flow_hash_fields(const struct flow *, enum nx_hash_fields,
212                           uint16_t basis);
213 const char *flow_hash_fields_to_str(enum nx_hash_fields);
214 bool flow_hash_fields_valid(enum nx_hash_fields);
215
216 #endif /* flow.h */