ofproto-dpif: Lock rules to prevent eviction.
[sliver-openvswitch.git] / ofproto / ofproto-dpif.h
1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
2  *
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:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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. */
14
15 #ifndef OFPROTO_DPIF_H
16 #define OFPROTO_DPIF_H 1
17
18 #include <stdint.h>
19
20 #include "hmapx.h"
21 #include "ofproto/ofproto-provider.h"
22 #include "ovs-thread.h"
23 #include "timer.h"
24 #include "util.h"
25 #include "ovs-thread.h"
26
27 union user_action_cookie;
28 struct ofproto_dpif;
29 struct ofport_dpif;
30 struct dpif_backer;
31
32 struct rule_dpif {
33     struct rule up;
34
35     /* These statistics:
36      *
37      *   - Do include packets and bytes from facets that have been deleted or
38      *     whose own statistics have been folded into the rule.
39      *
40      *   - Do include packets and bytes sent "by hand" that were accounted to
41      *     the rule without any facet being involved (this is a rare corner
42      *     case in rule_execute()).
43      *
44      *   - Do not include packet or bytes that can be obtained from any facet's
45      *     packet_count or byte_count member or that can be obtained from the
46      *     datapath by, e.g., dpif_flow_get() for any subfacet.
47      */
48     struct ovs_mutex stats_mutex;
49     uint64_t packet_count OVS_GUARDED;  /* Number of packets received. */
50     uint64_t byte_count OVS_GUARDED;    /* Number of bytes received. */
51 };
52
53 static inline struct rule_dpif *rule_dpif_cast(const struct rule *rule)
54 {
55     return rule ? CONTAINER_OF(rule, struct rule_dpif, up) : NULL;
56 }
57
58 void rule_dpif_lookup(struct ofproto_dpif *, const struct flow *,
59                       struct flow_wildcards *, struct rule_dpif **rule)
60     OVS_ACQ_RDLOCK((*rule)->up.evict);
61
62 bool rule_dpif_lookup_in_table(struct ofproto_dpif *, const struct flow *,
63                                struct flow_wildcards *, uint8_t table_id,
64                                struct rule_dpif **rule)
65     OVS_ACQ_RDLOCK((*rule)->up.evict);
66
67 void rule_release(struct rule_dpif *rule) OVS_RELEASES(rule->up.evict);
68
69 void rule_credit_stats(struct rule_dpif *, const struct dpif_flow_stats *);
70
71 struct rule_dpif *choose_miss_rule(enum ofputil_port_config,
72                                    struct rule_dpif *miss_rule,
73                                    struct rule_dpif *no_packet_in_rule);
74
75 bool ofproto_has_vlan_splinters(const struct ofproto_dpif *);
76 ofp_port_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
77                                   ofp_port_t realdev_ofp_port,
78                                   ovs_be16 vlan_tci);
79 bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *);
80
81 void ofproto_dpif_send_packet_in(struct ofproto_dpif *,
82                                  struct ofputil_packet_in *pin);
83 void ofproto_dpif_flow_mod(struct ofproto_dpif *, struct ofputil_flow_mod *);
84
85 struct ofport_dpif *odp_port_to_ofport(const struct dpif_backer *, odp_port_t);
86
87 #endif /* ofproto-dpif.h */