1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 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"
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
;
37 struct ofproto_packet_in
;
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 size_t ofproto_dpif_get_max_mpls_depth(const struct ofproto_dpif
*);
77 bool ofproto_dpif_get_enable_recirc(const struct ofproto_dpif
*);
78 bool ofproto_dpif_get_enable_ufid(struct dpif_backer
*backer
);
80 struct rule_dpif
*rule_dpif_lookup(struct ofproto_dpif
*, struct flow
*,
81 struct flow_wildcards
*, bool take_ref
,
82 const struct dpif_flow_stats
*,
85 struct rule_dpif
*rule_dpif_lookup_from_table(struct ofproto_dpif
*,
87 struct flow_wildcards
*,
89 const struct dpif_flow_stats
*,
93 bool honor_table_miss
);
95 /* If 'recirc_id' is set, starts looking up from internal table for
96 * post recirculation flows or packets. Otherwise, starts from table 0. */
98 rule_dpif_lookup_get_init_table_id(const struct flow
*flow
)
100 return flow
->recirc_id
? TBL_INTERNAL
: 0;
103 static inline void rule_dpif_ref(struct rule_dpif
*);
104 static inline void rule_dpif_unref(struct rule_dpif
*);
106 void rule_dpif_credit_stats(struct rule_dpif
*rule
,
107 const struct dpif_flow_stats
*);
109 static inline bool rule_dpif_is_fail_open(const struct rule_dpif
*);
110 static inline bool rule_dpif_is_table_miss(const struct rule_dpif
*);
111 static inline bool rule_dpif_is_internal(const struct rule_dpif
*);
113 uint8_t rule_dpif_get_table(const struct rule_dpif
*);
115 bool table_is_internal(uint8_t table_id
);
117 const struct rule_actions
*rule_dpif_get_actions(const struct rule_dpif
*);
118 uint32_t rule_dpif_get_recirc_id(struct rule_dpif
*);
119 void rule_set_recirc_id(struct rule
*, uint32_t id
);
121 ovs_be64
rule_dpif_get_flow_cookie(const struct rule_dpif
*rule
);
123 void rule_dpif_reduce_timeouts(struct rule_dpif
*rule
, uint16_t idle_timeout
,
124 uint16_t hard_timeout
);
126 void choose_miss_rule(enum ofputil_port_config
,
127 struct rule_dpif
*miss_rule
,
128 struct rule_dpif
*no_packet_in_rule
,
129 struct rule_dpif
**rule
, bool take_ref
);
131 void group_dpif_credit_stats(struct group_dpif
*,
132 struct ofputil_bucket
*,
133 const struct dpif_flow_stats
*);
134 bool group_dpif_lookup(struct ofproto_dpif
*ofproto
, uint32_t group_id
,
135 struct group_dpif
**group
);
137 void group_dpif_get_buckets(const struct group_dpif
*group
,
138 const struct ovs_list
**buckets
);
139 enum ofp11_group_type
group_dpif_get_type(const struct group_dpif
*group
);
141 bool ofproto_has_vlan_splinters(const struct ofproto_dpif
*);
142 ofp_port_t
vsp_realdev_to_vlandev(const struct ofproto_dpif
*,
143 ofp_port_t realdev_ofp_port
,
145 bool vsp_adjust_flow(const struct ofproto_dpif
*, struct flow
*,
146 struct ofpbuf
*packet
);
148 int ofproto_dpif_execute_actions(struct ofproto_dpif
*, const struct flow
*,
149 struct rule_dpif
*, const struct ofpact
*,
150 size_t ofpacts_len
, struct ofpbuf
*);
151 void ofproto_dpif_send_packet_in(struct ofproto_dpif
*,
152 struct ofproto_packet_in
*);
153 bool ofproto_dpif_wants_packet_in_on_miss(struct ofproto_dpif
*);
154 int ofproto_dpif_send_packet(const struct ofport_dpif
*, struct ofpbuf
*);
155 void ofproto_dpif_flow_mod(struct ofproto_dpif
*, struct ofputil_flow_mod
*);
156 struct rule_dpif
*ofproto_dpif_refresh_rule(struct rule_dpif
*);
158 struct ofport_dpif
*odp_port_to_ofport(const struct dpif_backer
*, odp_port_t
);
164 * Recirculation is a technique to allow a frame to re-enter the packet
165 * processing path for one or multiple times to achieve more flexible packet
166 * processing in the data path. MPLS handling and selecting bond slave port
169 * Data path and user space interface
170 * -----------------------------------
172 * Two new fields, recirc_id and dp_hash, are added to the current flow data
173 * structure. They are both of type uint32_t. In addition, a new action,
176 * The value recirc_id is used to distinguish a packet from multiple
177 * iterations of recirculation. A packet initially received is considered of
178 * having recirc_id of 0. Recirc_id is managed by the user space, opaque to
181 * On the other hand, dp_hash can only be computed by the data path, opaque to
182 * the user space. In fact, user space may not able to recompute the hash
183 * value. The dp_hash value should be wildcarded when for a newly received
184 * packet. RECIRC action specifies whether the hash is computed. If computed,
185 * how many fields to be included in the hash computation. The computed hash
186 * value is stored into the dp_hash field prior to recirculation.
188 * The RECIRC action computes and set the dp_hash field, set the recirc_id
189 * field and then reprocess the packet as if it was received on the same input
190 * port. RECIRC action works like a function call; actions listed behind the
191 * RECIRC action will be executed after its execution. RECIRC action can be
192 * nested, data path implementation limits the number of recirculation executed
193 * to prevent unreasonable nesting depth or infinite loop.
195 * Both flow fields and the RECIRC action are exposed as OpenFlow fields via
198 * Post recirculation flow
199 * ------------------------
201 * At the OpenFlow level, post recirculation rules are always hidden from the
202 * controller. They are installed in table 254 which is set up as a hidden
203 * table during boot time. Those rules are managed by the local user space
206 * To speed up the classifier look up process, recirc_id is always reflected
207 * into the metadata field, since recirc_id is required to be exactly matched.
209 * Classifier look up always starts with table 254. A post recirculation flow
210 * lookup should find its hidden rule within this table. On the other hand, A
211 * newly received packet should miss all post recirculation rules because its
212 * recirc_id is zero, then hit a pre-installed lower priority rule to redirect
213 * classifier to look up starting from table 0:
215 * * , actions=resubmit(,0)
217 * Post recirculation data path flows are managed like other data path flows.
218 * They are created on demand. Miss handling, stats collection and revalidation
219 * work the same way as regular flows.
221 * If the bridge which originates the recirculation is different from the bridge
222 * that receives the post recirculation packet (e.g. when patch port is used),
223 * the packet will be processed directly by the recirculation bridge with
224 * in_port set to OFPP_NONE. Admittedly, doing this limits the recirculation
225 * bridge from matching on in_port of post recirculation packets, and will be
226 * fixed in the near future.
228 * TODO: Always restore the correct in_port.
232 struct ofproto_dpif
*ofproto_dpif_recirc_get_ofproto(const struct dpif_backer
*ofproto
,
234 uint32_t ofproto_dpif_alloc_recirc_id(struct ofproto_dpif
*ofproto
);
235 void ofproto_dpif_free_recirc_id(struct ofproto_dpif
*ofproto
, uint32_t recirc_id
);
236 int ofproto_dpif_add_internal_flow(struct ofproto_dpif
*,
237 const struct match
*, int priority
,
238 uint16_t idle_timeout
,
239 const struct ofpbuf
*ofpacts
,
240 struct rule
**rulep
);
241 int ofproto_dpif_delete_internal_flow(struct ofproto_dpif
*, struct match
*,
244 /* struct rule_dpif has struct rule as it's first member. */
245 #define RULE_CAST(RULE) ((struct rule *)RULE)
246 #define GROUP_CAST(GROUP) ((struct ofgroup *)GROUP)
248 static inline struct group_dpif
* group_dpif_ref(struct group_dpif
*group
)
251 ofproto_group_ref(GROUP_CAST(group
));
256 static inline void group_dpif_unref(struct group_dpif
*group
)
259 ofproto_group_unref(GROUP_CAST(group
));
263 static inline void rule_dpif_ref(struct rule_dpif
*rule
)
266 ofproto_rule_ref(RULE_CAST(rule
));
270 static inline bool rule_dpif_try_ref(struct rule_dpif
*rule
)
273 return ofproto_rule_try_ref(RULE_CAST(rule
));
279 static inline void rule_dpif_unref(struct rule_dpif
*rule
)
282 ofproto_rule_unref(RULE_CAST(rule
));
286 static inline bool rule_dpif_is_fail_open(const struct rule_dpif
*rule
)
288 return is_fail_open_rule(RULE_CAST(rule
));
291 static inline bool rule_dpif_is_table_miss(const struct rule_dpif
*rule
)
293 return rule_is_table_miss(RULE_CAST(rule
));
296 /* Returns true if 'rule' is an internal rule, false otherwise. */
297 static inline bool rule_dpif_is_internal(const struct rule_dpif
*rule
)
299 return RULE_CAST(rule
)->table_id
== TBL_INTERNAL
;
304 bool ovs_native_tunneling_is_on(struct ofproto_dpif
*ofproto
);
305 #endif /* ofproto-dpif.h */