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
23 #include "ovs-thread.h"
24 #include "ofproto-provider.h"
27 #include "ovs-thread.h"
29 union user_action_cookie;
30 struct dpif_flow_stats;
33 struct ofproto_packet_in;
36 struct OVS_LOCKABLE rule_dpif;
37 struct OVS_LOCKABLE group_dpif;
39 enum rule_dpif_lookup_verdict {
40 RULE_DPIF_LOOKUP_VERDICT_MATCH, /* A match occurred. */
41 RULE_DPIF_LOOKUP_VERDICT_CONTROLLER, /* A miss occurred and the packet
44 RULE_DPIF_LOOKUP_VERDICT_DROP, /* A miss occurred and the packet
45 * should be dropped. */
46 RULE_DPIF_LOOKUP_VERDICT_DEFAULT, /* A miss occurred and the packet
47 * should handled by the default
49 * For pre-OF1.3 it should be
50 * forwarded to the controller.
51 * For OF1.3+ it should be
55 /* For lock annotation below only. */
56 extern struct ovs_rwlock xlate_rwlock;
58 /* Ofproto-dpif -- DPIF based ofproto implementation.
60 * Ofproto-dpif provides an ofproto implementation for those platforms which
61 * implement the netdev and dpif interface defined in netdev.h and dpif.h. The
62 * most important of which is the Linux Kernel Module (dpif-linux), but
63 * alternatives are supported such as a userspace only implementation
64 * (dpif-netdev), and a dummy implementation used for unit testing.
66 * Ofproto-dpif is divided into three major chunks.
69 * The main ofproto-dpif module is responsible for implementing the
70 * provider interface, installing and removing datapath flows, maintaining
71 * packet statistics, running protocols (BFD, LACP, STP, etc), and
72 * configuring relevant submodules.
74 * - ofproto-dpif-upcall.c
75 * Ofproto-dpif-upcall is responsible for retrieving upcalls from the kernel,
76 * processing miss upcalls, and handing more complex ones up to the main
77 * ofproto-dpif module. Miss upcall processing boils down to figuring out
78 * what each packet's actions are, executing them (i.e. asking the kernel to
79 * forward it), and handing it up to ofproto-dpif to decided whether or not
80 * to install a kernel flow.
82 * - ofproto-dpif-xlate.c
83 * Ofproto-dpif-xlate is responsible for translating translating OpenFlow
84 * actions into datapath actions. */
86 size_t ofproto_dpif_get_max_mpls_depth(const struct ofproto_dpif *);
87 bool ofproto_dpif_get_enable_recirc(const struct ofproto_dpif *);
89 uint8_t rule_dpif_lookup(struct ofproto_dpif *, struct flow *,
90 struct flow_wildcards *, struct rule_dpif **rule);
92 enum rule_dpif_lookup_verdict rule_dpif_lookup_from_table(struct ofproto_dpif *,
94 struct flow_wildcards *,
95 bool force_controller_on_miss,
97 struct rule_dpif **rule);
99 void rule_dpif_ref(struct rule_dpif *);
100 void rule_dpif_unref(struct rule_dpif *);
102 void rule_dpif_credit_stats(struct rule_dpif *rule ,
103 const struct dpif_flow_stats *);
105 bool rule_dpif_is_fail_open(const struct rule_dpif *);
106 bool rule_dpif_is_table_miss(const struct rule_dpif *);
107 bool rule_dpif_is_internal(const struct rule_dpif *);
108 uint8_t rule_dpif_get_table(const struct rule_dpif *);
110 struct rule_actions *rule_dpif_get_actions(const struct rule_dpif *);
112 ovs_be64 rule_dpif_get_flow_cookie(const struct rule_dpif *rule);
114 void rule_dpif_reduce_timeouts(struct rule_dpif *rule, uint16_t idle_timeout,
115 uint16_t hard_timeout);
117 void choose_miss_rule(enum ofputil_port_config,
118 struct rule_dpif *miss_rule,
119 struct rule_dpif *no_packet_in_rule,
120 struct rule_dpif **rule);
122 bool group_dpif_lookup(struct ofproto_dpif *ofproto, uint32_t group_id,
123 struct group_dpif **group);
125 void group_dpif_release(struct group_dpif *group);
127 void group_dpif_get_buckets(const struct group_dpif *group,
128 const struct list **buckets);
129 enum ofp11_group_type group_dpif_get_type(const struct group_dpif *group);
131 bool ofproto_has_vlan_splinters(const struct ofproto_dpif *);
132 ofp_port_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
133 ofp_port_t realdev_ofp_port,
135 bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *);
137 int ofproto_dpif_execute_actions(struct ofproto_dpif *, const struct flow *,
138 struct rule_dpif *, const struct ofpact *,
139 size_t ofpacts_len, struct ofpbuf *)
140 OVS_EXCLUDED(xlate_rwlock);
141 void ofproto_dpif_send_packet_in(struct ofproto_dpif *,
142 struct ofproto_packet_in *);
143 bool ofproto_dpif_wants_packet_in_on_miss(struct ofproto_dpif *);
144 int ofproto_dpif_send_packet(const struct ofport_dpif *, struct ofpbuf *);
145 void ofproto_dpif_flow_mod(struct ofproto_dpif *, struct ofputil_flow_mod *);
146 struct rule_dpif *ofproto_dpif_refresh_rule(struct rule_dpif *);
148 struct ofport_dpif *odp_port_to_ofport(const struct dpif_backer *, odp_port_t);
154 * Recirculation is a technique to allow a frame to re-enter the packet
155 * processing path for one or multiple times to achieve more flexible packet
156 * processing in the data path. MPLS handling and selecting bond slave port
159 * Data path and user space interface
160 * -----------------------------------
162 * Two new fields, recirc_id and dp_hash, are added to the current flow data
163 * structure. They are both of type uint32_t. In addition, a new action,
166 * The value recirc_id is used to distinguish a packet from multiple
167 * iterations of recirculation. A packet initially received is considered of
168 * having recirc_id of 0. Recirc_id is managed by the user space, opaque to
171 * On the other hand, dp_hash can only be computed by the data path, opaque to
172 * the user space. In fact, user space may not able to recompute the hash
173 * value. The dp_hash value should be wildcarded when for a newly received
174 * packet. RECIRC action specifies whether the hash is computed. If computed,
175 * how many fields to be included in the hash computation. The computed hash
176 * value is stored into the dp_hash field prior to recirculation.
178 * The RECIRC action computes and set the dp_hash field, set the recirc_id
179 * field and then reprocess the packet as if it was received on the same input
180 * port. RECIRC action works like a function call; actions listed behind the
181 * RECIRC action will be executed after its execution. RECIRC action can be
182 * nested, data path implementation limits the number of recirculation executed
183 * to prevent unreasonable nesting depth or infinite loop.
185 * Both flow fields and the RECIRC action are exposed as open flow fields via
188 * Post recirculation flow
189 * ------------------------
191 * At the open flow level, post recirculation rules are always hidden from the
192 * controller. They are installed in table 254 which is set up as a hidden
193 * table during boot time. Those rules are managed by the local user space
196 * To speed up the classifier look up process, recirc_id is always reflected
197 * into the metadata field, since recirc_id is required to be exactly matched.
199 * Classifier look up always starts with table 254. A post recirculation flow
200 * lookup should find its hidden rule within this table. On the other hand, A
201 * newly received packet should miss all post recirculation rules because its
202 * recirc_id is zero, then hit a pre-installed lower priority rule to redirect
203 * classifier to look up starting from table 0:
205 * * , actions=resubmit(,0)
207 * Post recirculation data path flows are managed like other data path flows.
208 * They are created on demand. Miss handling, stats collection and revalidation
209 * work the same way as regular flows.
212 uint32_t ofproto_dpif_alloc_recirc_id(struct ofproto_dpif *ofproto);
213 void ofproto_dpif_free_recirc_id(struct ofproto_dpif *ofproto, uint32_t recirc_id);
214 int ofproto_dpif_add_internal_flow(struct ofproto_dpif *,
215 struct match *, int priority,
216 const struct ofpbuf *ofpacts,
217 struct rule **rulep);
218 int ofproto_dpif_delete_internal_flow(struct ofproto_dpif *, struct match *,
221 #endif /* ofproto-dpif.h */