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
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 /* Ofproto-dpif -- DPIF based ofproto implementation.
39 * Ofproto-dpif provides an ofproto implementation for those platforms which
40 * implement the netdev and dpif interface defined in netdev.h and dpif.h. The
41 * most important of which is the Linux Kernel Module (dpif-linux), but
42 * alternatives are supported such as a userspace only implementation
43 * (dpif-netdev), and a dummy implementation used for unit testing.
45 * Ofproto-dpif is divided into three major chunks.
48 * The main ofproto-dpif module is responsible for implementing the
49 * provider interface, installing and removing datapath flows, maintaining
50 * packet statistics, running protocols (BFD, LACP, STP, etc), and
51 * configuring relevant submodules.
53 * - ofproto-dpif-upcall.c
54 * Ofproto-dpif-upcall is responsible for retrieving upcalls from the kernel,
55 * processing miss upcalls, and handing more complex ones up to the main
56 * ofproto-dpif module. Miss upcall processing boils down to figuring out
57 * what each packet's actions are, executing them (i.e. asking the kernel to
58 * forward it), and handing it up to ofproto-dpif to decided whether or not
59 * to install a kernel flow.
61 * - ofproto-dpif-xlate.c
62 * Ofproto-dpif-xlate is responsible for translating translating OpenFlow
63 * actions into datapath actions. */
65 void rule_dpif_lookup(struct ofproto_dpif *, const struct flow *,
66 struct flow_wildcards *, struct rule_dpif **rule);
68 bool rule_dpif_lookup_in_table(struct ofproto_dpif *, const struct flow *,
69 struct flow_wildcards *, uint8_t table_id,
70 struct rule_dpif **rule);
72 void rule_dpif_ref(struct rule_dpif *);
73 void rule_dpif_unref(struct rule_dpif *);
75 void rule_dpif_credit_stats(struct rule_dpif *rule ,
76 const struct dpif_flow_stats *);
78 bool rule_dpif_is_fail_open(const struct rule_dpif *);
79 bool rule_dpif_is_table_miss(const struct rule_dpif *);
81 struct rule_actions *rule_dpif_get_actions(const struct rule_dpif *);
83 ovs_be64 rule_dpif_get_flow_cookie(const struct rule_dpif *rule);
85 void rule_dpif_reduce_timeouts(struct rule_dpif *rule, uint16_t idle_timeout,
86 uint16_t hard_timeout);
88 void choose_miss_rule(enum ofputil_port_config,
89 struct rule_dpif *miss_rule,
90 struct rule_dpif *no_packet_in_rule,
91 struct rule_dpif **rule);
93 bool group_dpif_lookup(struct ofproto_dpif *ofproto, uint32_t group_id,
94 struct group_dpif **group);
96 void group_dpif_release(struct group_dpif *group);
98 void group_dpif_get_buckets(const struct group_dpif *group,
99 const struct list **buckets);
100 enum ofp11_group_type group_dpif_get_type(const struct group_dpif *group);
102 bool ofproto_has_vlan_splinters(const struct ofproto_dpif *);
103 ofp_port_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
104 ofp_port_t realdev_ofp_port,
106 bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *);
108 int ofproto_dpif_execute_actions(struct ofproto_dpif *, const struct flow *,
109 struct rule_dpif *, const struct ofpact *,
110 size_t ofpacts_len, struct ofpbuf *);
111 void ofproto_dpif_send_packet_in(struct ofproto_dpif *,
112 struct ofproto_packet_in *);
113 int ofproto_dpif_send_packet(const struct ofport_dpif *, struct ofpbuf *);
114 void ofproto_dpif_flow_mod(struct ofproto_dpif *, struct ofputil_flow_mod *);
116 struct ofport_dpif *odp_port_to_ofport(const struct dpif_backer *, odp_port_t);
118 #endif /* ofproto-dpif.h */