1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License. */
15 #ifndef OFPROTO_DPIF_H
16 #define OFPROTO_DPIF_H 1
21 #include "ofproto/ofproto-provider.h"
26 union user_action_cookie;
28 #define MAX_MIRRORS 32
29 typedef uint32_t mirror_mask_t;
30 #define MIRROR_MASK_C(X) UINT32_C(X)
31 BUILD_ASSERT_DECL(sizeof(mirror_mask_t) * CHAR_BIT >= MAX_MIRRORS);
33 /* Number of implemented OpenFlow tables. */
34 enum { N_TABLES = 255 };
35 enum { TBL_INTERNAL = N_TABLES - 1 }; /* Used for internal hidden rules. */
36 BUILD_ASSERT_DECL(N_TABLES >= 2 && N_TABLES <= 255);
38 /* Reasons that we might need to revalidate every facet, and corresponding
41 * A value of 0 means that there is no need to revalidate.
43 * It would be nice to have some cleaner way to integrate with coverage
44 * counters, but with only a few reasons I guess this is good enough for
46 enum revalidate_reason {
47 REV_RECONFIGURE = 1, /* Switch configuration changed. */
48 REV_STP, /* Spanning tree protocol port status change. */
49 REV_PORT_TOGGLED, /* Port enabled or disabled by CFM, LACP, ...*/
50 REV_FLOW_TABLE, /* Flow table changed. */
51 REV_INCONSISTENCY /* Facet self-check failed. */
59 * - Do include packets and bytes from facets that have been deleted or
60 * whose own statistics have been folded into the rule.
62 * - Do include packets and bytes sent "by hand" that were accounted to
63 * the rule without any facet being involved (this is a rare corner
64 * case in rule_execute()).
66 * - Do not include packet or bytes that can be obtained from any facet's
67 * packet_count or byte_count member or that can be obtained from the
68 * datapath by, e.g., dpif_flow_get() for any subfacet.
70 uint64_t packet_count; /* Number of packets received. */
71 uint64_t byte_count; /* Number of bytes received. */
73 tag_type tag; /* Caches rule_calculate_tag() result. */
75 struct list facets; /* List of "struct facet"s. */
78 struct avg_subfacet_rates {
79 double add_rate; /* Moving average of new flows created per minute. */
80 double del_rate; /* Moving average of flows deleted per minute. */
83 /* All datapaths of a given type share a single dpif backer instance. */
88 struct timer next_expiration;
89 struct hmap odp_to_ofport_map; /* ODP port to ofport mapping. */
91 struct simap tnl_backers; /* Set of dpif ports backing tunnels. */
93 /* Facet revalidation flags applying to facets which use this backer. */
94 enum revalidate_reason need_revalidate; /* Revalidate every facet. */
95 struct tag_set revalidate_set; /* Revalidate only matching facets. */
97 struct hmap drop_keys; /* Set of dropped odp keys. */
98 bool recv_set_enable; /* Enables or disables receiving packets. */
100 struct hmap subfacets;
101 struct governor *governor;
103 /* Subfacet statistics.
105 * These keep track of the total number of subfacets added and deleted and
106 * flow life span. They are useful for computing the flow rates stats
107 * exposed via "ovs-appctl dpif/show". The goal is to learn about
108 * traffic patterns in ways that we can use later to improve Open vSwitch
109 * performance in new situations. */
110 long long int created; /* Time when it is created. */
111 unsigned max_n_subfacet; /* Maximum number of flows */
112 unsigned avg_n_subfacet; /* Average number of flows. */
113 long long int avg_subfacet_life; /* Average life span of subfacets. */
115 /* The average number of subfacets... */
116 struct avg_subfacet_rates hourly; /* ...over the last hour. */
117 struct avg_subfacet_rates daily; /* ...over the last day. */
118 struct avg_subfacet_rates lifetime; /* ...over the switch lifetime. */
119 long long int last_minute; /* Last time 'hourly' was updated. */
121 /* Number of subfacets added or deleted since 'last_minute'. */
122 unsigned subfacet_add_count;
123 unsigned subfacet_del_count;
125 /* Number of subfacets added or deleted from 'created' to 'last_minute.' */
126 unsigned long long int total_subfacet_add_count;
127 unsigned long long int total_subfacet_del_count;
130 /* Extra information about a classifier table.
131 * Currently used just for optimized flow revalidation. */
133 /* If either of these is nonnull, then this table has a form that allows
134 * flows to be tagged to avoid revalidating most flows for the most common
135 * kinds of flow table changes. */
136 struct cls_table *catchall_table; /* Table that wildcards all fields. */
137 struct cls_table *other_table; /* Table with any other wildcard set. */
138 uint32_t basis; /* Keeps each table's tags separate. */
141 struct ofproto_dpif {
142 struct hmap_node all_ofproto_dpifs_node; /* In 'all_ofproto_dpifs'. */
144 struct dpif_backer *backer;
146 /* Special OpenFlow rules. */
147 struct rule_dpif *miss_rule; /* Sends flow table misses to controller. */
148 struct rule_dpif *no_packet_in_rule; /* Drops flow table misses. */
149 struct rule_dpif *drop_frags_rule; /* Used in OFPC_FRAG_DROP mode. */
152 struct netflow *netflow;
153 struct dpif_sflow *sflow;
154 struct dpif_ipfix *ipfix;
155 struct hmap bundles; /* Contains "struct ofbundle"s. */
156 struct mac_learning *ml;
157 struct ofmirror *mirrors[MAX_MIRRORS];
159 bool has_bonded_bundles;
162 struct classifier facets; /* Contains 'struct facet's. */
163 long long int consistency_rl;
166 struct table_dpif tables[N_TABLES];
168 /* Support for debugging async flow mods. */
169 struct list completions;
171 bool has_bundle_action; /* True when the first bundle action appears. */
172 struct netdev_stats stats; /* To account packets generated and consumed in
177 long long int stp_last_tick;
179 /* VLAN splinters. */
180 struct hmap realdev_vid_map; /* (realdev,vid) -> vlandev. */
181 struct hmap vlandev_map; /* vlandev -> (realdev,vid). */
184 struct sset ports; /* Set of standard port names. */
185 struct sset ghost_ports; /* Ports with no datapath port. */
186 struct sset port_poll_set; /* Queued names for port_poll() reply. */
187 int port_poll_errno; /* Last errno for port_poll() reply. */
189 /* Per ofproto's dpif stats. */
195 struct hmap_node odp_port_node; /* In dpif_backer's "odp_to_ofport_map". */
199 struct ofbundle *bundle; /* Bundle that contains this port, if any. */
200 struct list bundle_node; /* In struct ofbundle's "ports" list. */
201 struct cfm *cfm; /* Connectivity Fault Management, if any. */
202 struct bfd *bfd; /* BFD, if any. */
203 tag_type tag; /* Tag associated with this port. */
204 bool may_enable; /* May be enabled in bonds. */
205 long long int carrier_seq; /* Carrier status changes. */
206 struct tnl_port *tnl_port; /* Tunnel handle, or null. */
209 struct stp_port *stp_port; /* Spanning Tree Protocol, if any. */
210 enum stp_state stp_state; /* Always STP_DISABLED if STP not in use. */
211 long long int stp_state_entered;
213 struct hmap priorities; /* Map of attached 'priority_to_dscp's. */
215 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
217 * This is deprecated. It is only for compatibility with broken device
218 * drivers in old versions of Linux that do not properly support VLANs when
219 * VLAN devices are not used. When broken device drivers are no longer in
220 * widespread use, we will delete these interfaces. */
221 uint16_t realdev_ofp_port;
226 struct hmap_node hmap_node; /* In struct ofproto's "bundles" hmap. */
227 struct ofproto_dpif *ofproto; /* Owning ofproto. */
228 void *aux; /* Key supplied by ofproto's client. */
229 char *name; /* Identifier for log messages. */
232 struct list ports; /* Contains "struct ofport"s. */
233 enum port_vlan_mode vlan_mode; /* VLAN mode */
234 int vlan; /* -1=trunk port, else a 12-bit VLAN ID. */
235 unsigned long *trunks; /* Bitmap of trunked VLANs, if 'vlan' == -1.
236 * NULL if all VLANs are trunked. */
237 struct lacp *lacp; /* LACP if LACP is enabled, otherwise NULL. */
238 struct bond *bond; /* Nonnull iff more than one port. */
239 bool use_priority_tags; /* Use 802.1p tag for frames in VLAN 0? */
242 bool floodable; /* True if no port has OFPUTIL_PC_NO_FLOOD set. */
244 /* Port mirroring info. */
245 mirror_mask_t src_mirrors; /* Mirrors triggered when packet received. */
246 mirror_mask_t dst_mirrors; /* Mirrors triggered when packet sent. */
247 mirror_mask_t mirror_out; /* Mirrors that output to this bundle. */
251 struct ofproto_dpif *ofproto; /* Owning ofproto. */
252 size_t idx; /* In ofproto's "mirrors" array. */
253 void *aux; /* Key supplied by ofproto's client. */
254 char *name; /* Identifier for log messages. */
256 /* Selection criteria. */
257 struct hmapx srcs; /* Contains "struct ofbundle *"s. */
258 struct hmapx dsts; /* Contains "struct ofbundle *"s. */
259 unsigned long *vlans; /* Bitmap of chosen VLANs, NULL selects all. */
261 /* Output (exactly one of out == NULL and out_vlan == -1 is true). */
262 struct ofbundle *out; /* Output port or NULL. */
263 int out_vlan; /* Output VLAN or -1. */
264 mirror_mask_t dup_mirrors; /* Bitmap of mirrors with the same output. */
267 int64_t packet_count; /* Number of packets sent. */
268 int64_t byte_count; /* Number of bytes sent. */
271 /* Node in 'ofport_dpif''s 'priorities' map. Used to maintain a map from
272 * 'priority' (the datapath's term for QoS queue) to the dscp bits which all
273 * traffic egressing the 'ofport' with that priority should be marked with. */
274 struct priority_to_dscp {
275 struct hmap_node hmap_node; /* Node in 'ofport_dpif''s 'priorities' map. */
276 uint32_t priority; /* Priority of this queue (see struct flow). */
278 uint8_t dscp; /* DSCP bits to mark outgoing traffic with. */
281 static inline struct rule_dpif *rule_dpif_cast(const struct rule *rule)
283 return rule ? CONTAINER_OF(rule, struct rule_dpif, up) : NULL;
286 static inline struct ofproto_dpif *
287 ofproto_dpif_cast(const struct ofproto *ofproto)
289 ovs_assert(ofproto->ofproto_class == &ofproto_dpif_class);
290 return CONTAINER_OF(ofproto, struct ofproto_dpif, up);
293 static inline struct ofport_dpif *
294 ofbundle_get_a_port(const struct ofbundle *bundle)
296 return CONTAINER_OF(list_front(&bundle->ports), struct ofport_dpif,
301 mirror_mask_ffs(mirror_mask_t mask)
303 BUILD_ASSERT_DECL(sizeof(unsigned int) >= sizeof(mask));
307 struct ofport_dpif *get_ofp_port(const struct ofproto_dpif *,
310 struct ofport_dpif *get_odp_port(const struct ofproto_dpif *,
313 struct ofport_dpif *ofport_get_peer(const struct ofport_dpif *);
315 uint32_t ofp_port_to_odp_port(const struct ofproto_dpif *, uint16_t ofp_port);
317 struct rule_dpif *rule_dpif_lookup_in_table(struct ofproto_dpif *,
319 struct flow_wildcards *,
322 tag_type rule_calculate_tag(const struct flow *flow, const struct minimask *,
325 struct rule_dpif *rule_dpif_miss_rule(struct ofproto_dpif *ofproto,
326 const struct flow *);
328 void rule_credit_stats(struct rule_dpif *, const struct dpif_flow_stats *);
330 void ofproto_trace(struct ofproto_dpif *, const struct flow *,
331 const struct ofpbuf *packet, struct ds *);
333 size_t put_userspace_action(const struct ofproto_dpif *,
334 struct ofpbuf *odp_actions, const struct flow *,
335 const union user_action_cookie *,
336 const size_t cookie_size);
338 enum slow_path_reason process_special(struct ofproto_dpif *,
340 const struct ofport_dpif *,
341 const struct ofpbuf *packet);
343 uint16_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
344 uint16_t realdev_ofp_port,
347 struct priority_to_dscp *get_priority(const struct ofport_dpif *,
351 #endif /* ofproto-dpif.h */