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"
26 #include "ovs-thread.h"
28 union user_action_cookie;
29 struct dpif_flow_stats;
31 struct ofproto_packet_in;
34 struct OVS_LOCKABLE rule_dpif;
35 struct OVS_LOCKABLE group_dpif;
37 enum rule_dpif_lookup_verdict {
38 RULE_DPIF_LOOKUP_VERDICT_MATCH, /* A match occurred. */
39 RULE_DPIF_LOOKUP_VERDICT_CONTROLLER, /* A miss occurred and the packet
42 RULE_DPIF_LOOKUP_VERDICT_DROP, /* A miss occurred and the packet
43 * should be dropped. */
46 /* For lock annotation below only. */
47 extern struct ovs_rwlock xlate_rwlock;
49 /* Ofproto-dpif -- DPIF based ofproto implementation.
51 * Ofproto-dpif provides an ofproto implementation for those platforms which
52 * implement the netdev and dpif interface defined in netdev.h and dpif.h. The
53 * most important of which is the Linux Kernel Module (dpif-linux), but
54 * alternatives are supported such as a userspace only implementation
55 * (dpif-netdev), and a dummy implementation used for unit testing.
57 * Ofproto-dpif is divided into three major chunks.
60 * The main ofproto-dpif module is responsible for implementing the
61 * provider interface, installing and removing datapath flows, maintaining
62 * packet statistics, running protocols (BFD, LACP, STP, etc), and
63 * configuring relevant submodules.
65 * - ofproto-dpif-upcall.c
66 * Ofproto-dpif-upcall is responsible for retrieving upcalls from the kernel,
67 * processing miss upcalls, and handing more complex ones up to the main
68 * ofproto-dpif module. Miss upcall processing boils down to figuring out
69 * what each packet's actions are, executing them (i.e. asking the kernel to
70 * forward it), and handing it up to ofproto-dpif to decided whether or not
71 * to install a kernel flow.
73 * - ofproto-dpif-xlate.c
74 * Ofproto-dpif-xlate is responsible for translating translating OpenFlow
75 * actions into datapath actions. */
77 size_t ofproto_dpif_get_max_mpls_depth(const struct ofproto_dpif *);
79 uint8_t rule_dpif_lookup(struct ofproto_dpif *, const struct flow *,
80 struct flow_wildcards *, struct rule_dpif **rule);
82 enum rule_dpif_lookup_verdict rule_dpif_lookup_from_table(struct ofproto_dpif *,
84 struct flow_wildcards *,
85 bool force_controller_on_miss,
87 struct rule_dpif **rule);
89 void rule_dpif_ref(struct rule_dpif *);
90 void rule_dpif_unref(struct rule_dpif *);
92 void rule_dpif_credit_stats(struct rule_dpif *rule ,
93 const struct dpif_flow_stats *);
95 bool rule_dpif_is_fail_open(const struct rule_dpif *);
96 bool rule_dpif_is_table_miss(const struct rule_dpif *);
97 bool rule_dpif_is_internal(const struct rule_dpif *);
99 struct rule_actions *rule_dpif_get_actions(const struct rule_dpif *);
101 ovs_be64 rule_dpif_get_flow_cookie(const struct rule_dpif *rule);
103 void rule_dpif_reduce_timeouts(struct rule_dpif *rule, uint16_t idle_timeout,
104 uint16_t hard_timeout);
106 void choose_miss_rule(enum ofputil_port_config,
107 struct rule_dpif *miss_rule,
108 struct rule_dpif *no_packet_in_rule,
109 struct rule_dpif **rule);
111 bool group_dpif_lookup(struct ofproto_dpif *ofproto, uint32_t group_id,
112 struct group_dpif **group);
114 void group_dpif_release(struct group_dpif *group);
116 void group_dpif_get_buckets(const struct group_dpif *group,
117 const struct list **buckets);
118 enum ofp11_group_type group_dpif_get_type(const struct group_dpif *group);
120 bool ofproto_has_vlan_splinters(const struct ofproto_dpif *);
121 ofp_port_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
122 ofp_port_t realdev_ofp_port,
124 bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *);
126 int ofproto_dpif_execute_actions(struct ofproto_dpif *, const struct flow *,
127 struct rule_dpif *, const struct ofpact *,
128 size_t ofpacts_len, struct ofpbuf *)
129 OVS_EXCLUDED(xlate_rwlock);
130 void ofproto_dpif_send_packet_in(struct ofproto_dpif *,
131 struct ofproto_packet_in *);
132 int ofproto_dpif_send_packet(const struct ofport_dpif *, struct ofpbuf *);
133 void ofproto_dpif_flow_mod(struct ofproto_dpif *, struct ofputil_flow_mod *);
135 struct ofport_dpif *odp_port_to_ofport(const struct dpif_backer *, odp_port_t);
137 #endif /* ofproto-dpif.h */