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;
32 struct ofproto_packet_in;
35 struct OVS_LOCKABLE rule_dpif;
36 struct OVS_LOCKABLE group_dpif;
38 enum rule_dpif_lookup_verdict {
39 RULE_DPIF_LOOKUP_VERDICT_MATCH, /* A match occurred. */
40 RULE_DPIF_LOOKUP_VERDICT_CONTROLLER, /* A miss occurred and the packet
43 RULE_DPIF_LOOKUP_VERDICT_DROP, /* A miss occurred and the packet
44 * should be dropped. */
47 /* For lock annotation below only. */
48 extern struct ovs_rwlock xlate_rwlock;
50 /* Ofproto-dpif -- DPIF based ofproto implementation.
52 * Ofproto-dpif provides an ofproto implementation for those platforms which
53 * implement the netdev and dpif interface defined in netdev.h and dpif.h. The
54 * most important of which is the Linux Kernel Module (dpif-linux), but
55 * alternatives are supported such as a userspace only implementation
56 * (dpif-netdev), and a dummy implementation used for unit testing.
58 * Ofproto-dpif is divided into three major chunks.
61 * The main ofproto-dpif module is responsible for implementing the
62 * provider interface, installing and removing datapath flows, maintaining
63 * packet statistics, running protocols (BFD, LACP, STP, etc), and
64 * configuring relevant submodules.
66 * - ofproto-dpif-upcall.c
67 * Ofproto-dpif-upcall is responsible for retrieving upcalls from the kernel,
68 * processing miss upcalls, and handing more complex ones up to the main
69 * ofproto-dpif module. Miss upcall processing boils down to figuring out
70 * what each packet's actions are, executing them (i.e. asking the kernel to
71 * forward it), and handing it up to ofproto-dpif to decided whether or not
72 * to install a kernel flow.
74 * - ofproto-dpif-xlate.c
75 * Ofproto-dpif-xlate is responsible for translating translating OpenFlow
76 * actions into datapath actions. */
78 size_t ofproto_dpif_get_max_mpls_depth(const struct ofproto_dpif *);
80 uint8_t rule_dpif_lookup(struct ofproto_dpif *, const struct flow *,
81 struct flow_wildcards *, struct rule_dpif **rule);
83 enum rule_dpif_lookup_verdict rule_dpif_lookup_from_table(struct ofproto_dpif *,
85 struct flow_wildcards *,
86 bool force_controller_on_miss,
88 struct rule_dpif **rule);
90 void rule_dpif_ref(struct rule_dpif *);
91 void rule_dpif_unref(struct rule_dpif *);
93 void rule_dpif_credit_stats(struct rule_dpif *rule ,
94 const struct dpif_flow_stats *);
96 bool rule_dpif_is_fail_open(const struct rule_dpif *);
97 bool rule_dpif_is_table_miss(const struct rule_dpif *);
98 bool rule_dpif_is_internal(const struct rule_dpif *);
100 struct rule_actions *rule_dpif_get_actions(const struct rule_dpif *);
102 ovs_be64 rule_dpif_get_flow_cookie(const struct rule_dpif *rule);
104 void rule_dpif_reduce_timeouts(struct rule_dpif *rule, uint16_t idle_timeout,
105 uint16_t hard_timeout);
107 void choose_miss_rule(enum ofputil_port_config,
108 struct rule_dpif *miss_rule,
109 struct rule_dpif *no_packet_in_rule,
110 struct rule_dpif **rule);
112 bool group_dpif_lookup(struct ofproto_dpif *ofproto, uint32_t group_id,
113 struct group_dpif **group);
115 void group_dpif_release(struct group_dpif *group);
117 void group_dpif_get_buckets(const struct group_dpif *group,
118 const struct list **buckets);
119 enum ofp11_group_type group_dpif_get_type(const struct group_dpif *group);
121 bool ofproto_has_vlan_splinters(const struct ofproto_dpif *);
122 ofp_port_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
123 ofp_port_t realdev_ofp_port,
125 bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *);
127 int ofproto_dpif_execute_actions(struct ofproto_dpif *, const struct flow *,
128 struct rule_dpif *, const struct ofpact *,
129 size_t ofpacts_len, struct ofpbuf *)
130 OVS_EXCLUDED(xlate_rwlock);
131 void ofproto_dpif_send_packet_in(struct ofproto_dpif *,
132 struct ofproto_packet_in *);
133 int ofproto_dpif_send_packet(const struct ofport_dpif *, struct ofpbuf *);
134 void ofproto_dpif_flow_mod(struct ofproto_dpif *, struct ofputil_flow_mod *);
136 struct ofport_dpif *odp_port_to_ofport(const struct dpif_backer *, odp_port_t);
138 uint32_t ofproto_dpif_alloc_recirc_id(struct ofproto_dpif *ofproto);
139 void ofproto_dpif_free_recirc_id(struct ofproto_dpif *ofproto, uint32_t recirc_id);
140 #endif /* ofproto-dpif.h */