1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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
20 #include "fail-open.h"
23 #include "openvswitch/ofp-util.h"
24 #include "ovs-thread.h"
25 #include "ofproto-provider.h"
28 #include "ovs-thread.h"
30 /* Priority for internal rules created to handle recirculation */
31 #define RECIRC_RULE_PRIORITY 20
33 union user_action_cookie;
34 struct dpif_flow_stats;
36 struct ofproto_async_msg;
40 struct OVS_LOCKABLE rule_dpif;
41 struct OVS_LOCKABLE group_dpif;
43 /* Number of implemented OpenFlow tables. */
44 enum { N_TABLES = 255 };
45 enum { TBL_INTERNAL = N_TABLES - 1 }; /* Used for internal hidden rules. */
46 BUILD_ASSERT_DECL(N_TABLES >= 2 && N_TABLES <= 255);
48 /* Ofproto-dpif -- DPIF based ofproto implementation.
50 * Ofproto-dpif provides an ofproto implementation for those platforms which
51 * implement the netdev and dpif interface defined in netdev.h and dpif.h. The
52 * most important of which is the Linux Kernel Module (dpif-linux), but
53 * alternatives are supported such as a userspace only implementation
54 * (dpif-netdev), and a dummy implementation used for unit testing.
56 * Ofproto-dpif is divided into three major chunks.
59 * The main ofproto-dpif module is responsible for implementing the
60 * provider interface, installing and removing datapath flows, maintaining
61 * packet statistics, running protocols (BFD, LACP, STP, etc), and
62 * configuring relevant submodules.
64 * - ofproto-dpif-upcall.c
65 * Ofproto-dpif-upcall is responsible for retrieving upcalls from the kernel,
66 * processing miss upcalls, and handing more complex ones up to the main
67 * ofproto-dpif module. Miss upcall processing boils down to figuring out
68 * what each packet's actions are, executing them (i.e. asking the kernel to
69 * forward it), and handing it up to ofproto-dpif to decided whether or not
70 * to install a kernel flow.
72 * - ofproto-dpif-xlate.c
73 * Ofproto-dpif-xlate is responsible for translating OpenFlow actions into
74 * datapath actions. */
76 /* Stores the various features which the corresponding backer supports. */
77 struct dpif_backer_support {
78 /* True if the datapath supports variable-length
79 * OVS_USERSPACE_ATTR_USERDATA in OVS_ACTION_ATTR_USERSPACE actions.
80 * False if the datapath supports only 8-byte (or shorter) userdata. */
81 bool variable_length_userdata;
83 /* True if the datapath supports masked data in OVS_ACTION_ATTR_SET
85 bool masked_set_action;
87 /* True if the datapath supports tnl_push and pop actions. */
90 /* True if the datapath supports OVS_FLOW_ATTR_UFID. */
93 /* Each member represents support for related OVS_KEY_ATTR_* fields. */
94 struct odp_support odp;
97 bool ofproto_dpif_get_enable_ufid(const struct dpif_backer *backer);
98 struct dpif_backer_support *ofproto_dpif_get_support(const struct ofproto_dpif *);
100 cls_version_t ofproto_dpif_get_tables_version(struct ofproto_dpif *);
102 struct rule_dpif *rule_dpif_lookup_from_table(struct ofproto_dpif *,
103 cls_version_t, struct flow *,
104 struct flow_wildcards *,
105 const struct dpif_flow_stats *,
109 bool honor_table_miss);
111 static inline void rule_dpif_ref(struct rule_dpif *);
112 static inline void rule_dpif_unref(struct rule_dpif *);
114 void rule_dpif_credit_stats(struct rule_dpif *rule ,
115 const struct dpif_flow_stats *);
117 static inline bool rule_dpif_is_fail_open(const struct rule_dpif *);
118 static inline bool rule_dpif_is_table_miss(const struct rule_dpif *);
119 static inline bool rule_dpif_is_internal(const struct rule_dpif *);
121 uint8_t rule_dpif_get_table(const struct rule_dpif *);
123 bool table_is_internal(uint8_t table_id);
125 const struct rule_actions *rule_dpif_get_actions(const struct rule_dpif *);
126 void rule_set_recirc_id(struct rule *, uint32_t id);
128 ovs_be64 rule_dpif_get_flow_cookie(const struct rule_dpif *rule);
130 void rule_dpif_reduce_timeouts(struct rule_dpif *rule, uint16_t idle_timeout,
131 uint16_t hard_timeout);
133 void group_dpif_credit_stats(struct group_dpif *,
134 struct ofputil_bucket *,
135 const struct dpif_flow_stats *);
136 bool group_dpif_lookup(struct ofproto_dpif *ofproto, uint32_t group_id,
137 struct group_dpif **group);
139 void group_dpif_get_buckets(const struct group_dpif *group,
140 const struct ovs_list **buckets);
141 enum ofp11_group_type group_dpif_get_type(const struct group_dpif *group);
142 const char *group_dpif_get_selection_method(const struct group_dpif *group);
143 uint64_t group_dpif_get_selection_method_param(const struct group_dpif *group);
144 const struct field_array *group_dpif_get_fields(const struct group_dpif *group);
146 int ofproto_dpif_execute_actions(struct ofproto_dpif *, const struct flow *,
147 struct rule_dpif *, const struct ofpact *,
148 size_t ofpacts_len, struct dp_packet *);
149 int ofproto_dpif_execute_actions__(struct ofproto_dpif *, const struct flow *,
150 struct rule_dpif *, const struct ofpact *,
151 size_t ofpacts_len, int recurse,
152 int resubmits, struct dp_packet *);
153 void ofproto_dpif_send_async_msg(struct ofproto_dpif *,
154 struct ofproto_async_msg *);
155 bool ofproto_dpif_wants_packet_in_on_miss(struct ofproto_dpif *);
156 int ofproto_dpif_send_packet(const struct ofport_dpif *, struct dp_packet *);
157 void ofproto_dpif_flow_mod(struct ofproto_dpif *,
158 const struct ofputil_flow_mod *);
159 struct rule_dpif *ofproto_dpif_refresh_rule(struct rule_dpif *);
161 struct ofport_dpif *odp_port_to_ofport(const struct dpif_backer *, odp_port_t);
162 struct ofport_dpif *ofp_port_to_ofport(const struct ofproto_dpif *,
165 bool ofproto_dpif_backer_enabled(struct dpif_backer* backer);
167 int ofproto_dpif_add_internal_flow(struct ofproto_dpif *,
168 const struct match *, int priority,
169 uint16_t idle_timeout,
170 const struct ofpbuf *ofpacts,
171 struct rule **rulep);
172 int ofproto_dpif_delete_internal_flow(struct ofproto_dpif *, struct match *,
175 const struct uuid *ofproto_dpif_get_uuid(const struct ofproto_dpif *);
177 /* struct rule_dpif has struct rule as it's first member. */
178 #define RULE_CAST(RULE) ((struct rule *)RULE)
179 #define GROUP_CAST(GROUP) ((struct ofgroup *)GROUP)
181 static inline struct group_dpif* group_dpif_ref(struct group_dpif *group)
184 ofproto_group_ref(GROUP_CAST(group));
189 static inline void group_dpif_unref(struct group_dpif *group)
192 ofproto_group_unref(GROUP_CAST(group));
196 static inline void rule_dpif_ref(struct rule_dpif *rule)
199 ofproto_rule_ref(RULE_CAST(rule));
203 static inline void rule_dpif_unref(struct rule_dpif *rule)
206 ofproto_rule_unref(RULE_CAST(rule));
210 static inline bool rule_dpif_is_fail_open(const struct rule_dpif *rule)
212 return is_fail_open_rule(RULE_CAST(rule));
215 static inline bool rule_dpif_is_table_miss(const struct rule_dpif *rule)
217 return rule_is_table_miss(RULE_CAST(rule));
220 /* Returns true if 'rule' is an internal rule, false otherwise. */
221 static inline bool rule_dpif_is_internal(const struct rule_dpif *rule)
223 return RULE_CAST(rule)->table_id == TBL_INTERNAL;
228 bool ovs_native_tunneling_is_on(struct ofproto_dpif *ofproto);
229 #endif /* ofproto-dpif.h */