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);
43 * - Do include packets and bytes from facets that have been deleted or
44 * whose own statistics have been folded into the rule.
46 * - Do include packets and bytes sent "by hand" that were accounted to
47 * the rule without any facet being involved (this is a rare corner
48 * case in rule_execute()).
50 * - Do not include packet or bytes that can be obtained from any facet's
51 * packet_count or byte_count member or that can be obtained from the
52 * datapath by, e.g., dpif_flow_get() for any subfacet.
54 uint64_t packet_count; /* Number of packets received. */
55 uint64_t byte_count; /* Number of bytes received. */
57 tag_type tag; /* Caches rule_calculate_tag() result. */
59 struct list facets; /* List of "struct facet"s. */
62 /* Extra information about a classifier table.
63 * Currently used just for optimized flow revalidation. */
65 /* If either of these is nonnull, then this table has a form that allows
66 * flows to be tagged to avoid revalidating most flows for the most common
67 * kinds of flow table changes. */
68 struct cls_table *catchall_table; /* Table that wildcards all fields. */
69 struct cls_table *other_table; /* Table with any other wildcard set. */
70 uint32_t basis; /* Keeps each table's tags separate. */
74 struct hmap_node all_ofproto_dpifs_node; /* In 'all_ofproto_dpifs'. */
76 struct dpif_backer *backer;
78 /* Special OpenFlow rules. */
79 struct rule_dpif *miss_rule; /* Sends flow table misses to controller. */
80 struct rule_dpif *no_packet_in_rule; /* Drops flow table misses. */
81 struct rule_dpif *drop_frags_rule; /* Used in OFPC_FRAG_DROP mode. */
84 struct netflow *netflow;
85 struct dpif_sflow *sflow;
86 struct dpif_ipfix *ipfix;
87 struct hmap bundles; /* Contains "struct ofbundle"s. */
88 struct mac_learning *ml;
89 struct ofmirror *mirrors[MAX_MIRRORS];
91 bool has_bonded_bundles;
94 struct classifier facets; /* Contains 'struct facet's. */
95 long long int consistency_rl;
98 struct table_dpif tables[N_TABLES];
100 /* Support for debugging async flow mods. */
101 struct list completions;
103 struct netdev_stats stats; /* To account packets generated and consumed in
108 long long int stp_last_tick;
110 /* VLAN splinters. */
111 struct hmap realdev_vid_map; /* (realdev,vid) -> vlandev. */
112 struct hmap vlandev_map; /* vlandev -> (realdev,vid). */
115 struct sset ports; /* Set of standard port names. */
116 struct sset ghost_ports; /* Ports with no datapath port. */
117 struct sset port_poll_set; /* Queued names for port_poll() reply. */
118 int port_poll_errno; /* Last errno for port_poll() reply. */
120 /* Per ofproto's dpif stats. */
126 struct hmap_node odp_port_node; /* In dpif_backer's "odp_to_ofport_map". */
130 struct ofbundle *bundle; /* Bundle that contains this port, if any. */
131 struct list bundle_node; /* In struct ofbundle's "ports" list. */
132 struct cfm *cfm; /* Connectivity Fault Management, if any. */
133 struct bfd *bfd; /* BFD, if any. */
134 tag_type tag; /* Tag associated with this port. */
135 bool may_enable; /* May be enabled in bonds. */
136 bool is_tunnel; /* This port is a tunnel. */
137 long long int carrier_seq; /* Carrier status changes. */
138 struct ofport_dpif *peer; /* Peer if patch port. */
141 struct stp_port *stp_port; /* Spanning Tree Protocol, if any. */
142 enum stp_state stp_state; /* Always STP_DISABLED if STP not in use. */
143 long long int stp_state_entered;
145 struct hmap priorities; /* Map of attached 'priority_to_dscp's. */
147 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
149 * This is deprecated. It is only for compatibility with broken device
150 * drivers in old versions of Linux that do not properly support VLANs when
151 * VLAN devices are not used. When broken device drivers are no longer in
152 * widespread use, we will delete these interfaces. */
153 ofp_port_t realdev_ofp_port;
158 struct hmap_node hmap_node; /* In struct ofproto's "bundles" hmap. */
159 struct ofproto_dpif *ofproto; /* Owning ofproto. */
160 void *aux; /* Key supplied by ofproto's client. */
161 char *name; /* Identifier for log messages. */
164 struct list ports; /* Contains "struct ofport"s. */
165 enum port_vlan_mode vlan_mode; /* VLAN mode */
166 int vlan; /* -1=trunk port, else a 12-bit VLAN ID. */
167 unsigned long *trunks; /* Bitmap of trunked VLANs, if 'vlan' == -1.
168 * NULL if all VLANs are trunked. */
169 struct lacp *lacp; /* LACP if LACP is enabled, otherwise NULL. */
170 struct bond *bond; /* Nonnull iff more than one port. */
171 bool use_priority_tags; /* Use 802.1p tag for frames in VLAN 0? */
174 bool floodable; /* True if no port has OFPUTIL_PC_NO_FLOOD set. */
176 /* Port mirroring info. */
177 mirror_mask_t src_mirrors; /* Mirrors triggered when packet received. */
178 mirror_mask_t dst_mirrors; /* Mirrors triggered when packet sent. */
179 mirror_mask_t mirror_out; /* Mirrors that output to this bundle. */
183 struct ofproto_dpif *ofproto; /* Owning ofproto. */
184 size_t idx; /* In ofproto's "mirrors" array. */
185 void *aux; /* Key supplied by ofproto's client. */
186 char *name; /* Identifier for log messages. */
188 /* Selection criteria. */
189 struct hmapx srcs; /* Contains "struct ofbundle *"s. */
190 struct hmapx dsts; /* Contains "struct ofbundle *"s. */
191 unsigned long *vlans; /* Bitmap of chosen VLANs, NULL selects all. */
193 /* Output (exactly one of out == NULL and out_vlan == -1 is true). */
194 struct ofbundle *out; /* Output port or NULL. */
195 int out_vlan; /* Output VLAN or -1. */
196 mirror_mask_t dup_mirrors; /* Bitmap of mirrors with the same output. */
199 int64_t packet_count; /* Number of packets sent. */
200 int64_t byte_count; /* Number of bytes sent. */
203 static inline struct rule_dpif *rule_dpif_cast(const struct rule *rule)
205 return rule ? CONTAINER_OF(rule, struct rule_dpif, up) : NULL;
208 static inline struct ofproto_dpif *
209 ofproto_dpif_cast(const struct ofproto *ofproto)
211 ovs_assert(ofproto->ofproto_class == &ofproto_dpif_class);
212 return CONTAINER_OF(ofproto, struct ofproto_dpif, up);
215 static inline struct ofport_dpif *
216 ofbundle_get_a_port(const struct ofbundle *bundle)
218 return CONTAINER_OF(list_front(&bundle->ports), struct ofport_dpif,
223 mirror_mask_ffs(mirror_mask_t mask)
225 BUILD_ASSERT_DECL(sizeof(unsigned int) >= sizeof(mask));
229 struct ofport_dpif *get_ofp_port(const struct ofproto_dpif *,
230 ofp_port_t ofp_port);
232 struct ofport_dpif *get_odp_port(const struct ofproto_dpif *,
233 odp_port_t odp_port);
235 odp_port_t ofp_port_to_odp_port(const struct ofproto_dpif *,
236 ofp_port_t ofp_port);
238 struct rule_dpif *rule_dpif_lookup_in_table(struct ofproto_dpif *,
240 struct flow_wildcards *,
243 tag_type rule_calculate_tag(const struct flow *flow, const struct minimask *,
246 struct rule_dpif *rule_dpif_miss_rule(struct ofproto_dpif *ofproto,
247 const struct flow *);
249 void rule_credit_stats(struct rule_dpif *, const struct dpif_flow_stats *);
251 void ofproto_trace(struct ofproto_dpif *, const struct flow *,
252 const struct ofpbuf *packet, struct ds *);
254 size_t put_userspace_action(const struct ofproto_dpif *,
255 struct ofpbuf *odp_actions, const struct flow *,
256 const union user_action_cookie *,
257 const size_t cookie_size);
259 bool stp_should_process_flow(const struct flow *, struct flow_wildcards *);
260 void stp_process_packet(const struct ofport_dpif *,
261 const struct ofpbuf *packet);
263 ofp_port_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
264 ofp_port_t realdev_ofp_port,
267 bool ofproto_dpif_dscp_from_priority(const struct ofport_dpif *,
268 uint32_t priority, uint8_t *dscp);
269 int ofproto_dpif_queue_to_priority(const struct ofproto_dpif *,
270 uint32_t queue_id, uint32_t *priority);
271 tag_type calculate_flow_tag(struct ofproto_dpif *, const struct flow *,
272 uint8_t table_id, struct rule_dpif *);
274 #endif /* ofproto-dpif.h */