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 "odp-util.h"
  22 #include "ofproto/ofproto-provider.h"
  23 #include "ovs-thread.h"
  24 #include "timer.h"
  25 #include "util.h"
  26 #include "ovs-thread.h"
  27
  28 union user_action_cookie;
  29 struct ofproto_dpif;
  30 struct ofport_dpif;
  31 struct dpif_backer;
  32
  33 /* Ofproto-dpif -- DPIF based ofproto implementation.
  34  *
  35  * Ofproto-dpif provides an ofproto implementation for those platforms which
  36  * implement the netdev and dpif interface defined in netdev.h and dpif.h.  The
  37  * most important of which is the Linux Kernel Module (dpif-linux), but
  38  * alternatives are supported such as a userspace only implementation
  39  * (dpif-netdev), and a dummy implementation used for unit testing.
  40  *
  41  * Ofproto-dpif is divided into three major chunks.
  42  *
  43  * - ofproto-dpif.c
  44  *   The main ofproto-dpif module is responsible for implementing the
  45  *   provider interface, installing and removing datapath flows, maintaining
  46  *   packet statistics, running protocols (BFD, LACP, STP, etc), and
  47  *   configuring relevant submodules.
  48  *
  49  * - ofproto-dpif-upcall.c
  50  *   Ofproto-dpif-upcall is responsible for retrieving upcalls from the kernel,
  51  *   processing miss upcalls, and handing more complex ones up to the main
  52  *   ofproto-dpif module.  Miss upcall processing boils down to figuring out
  53  *   what each packet's actions are, executing them (i.e. asking the kernel to
  54  *   forward it), and handing it up to ofproto-dpif to decided whether or not
  55  *   to install a kernel flow.
  56  *
  57  * - ofproto-dpif-xlate.c
  58  *   Ofproto-dpif-xlate is responsible for translating translating OpenFlow
  59  *   actions into datapath actions. */
  60
  61 struct rule_dpif {
  62     struct rule up;
  63
  64     /* These statistics:
  65      *
  66      *   - Do include packets and bytes from facets that have been deleted or
  67      *     whose own statistics have been folded into the rule.
  68      *
  69      *   - Do include packets and bytes sent "by hand" that were accounted to
  70      *     the rule without any facet being involved (this is a rare corner
  71      *     case in rule_execute()).
  72      *
  73      *   - Do not include packet or bytes that can be obtained from any facet's
  74      *     packet_count or byte_count member or that can be obtained from the
  75      *     datapath by, e.g., dpif_flow_get() for any subfacet.
  76      */
  77     struct ovs_mutex stats_mutex;
  78     uint64_t packet_count OVS_GUARDED;  /* Number of packets received. */
  79     uint64_t byte_count OVS_GUARDED;    /* Number of bytes received. */
  80 };
  81
  82 static inline struct rule_dpif *rule_dpif_cast(const struct rule *rule)
  83 {
  84     return rule ? CONTAINER_OF(rule, struct rule_dpif, up) : NULL;
  85 }
  86
  87 void rule_dpif_lookup(struct ofproto_dpif *, const struct flow *,
  88                       struct flow_wildcards *, struct rule_dpif **rule)
  89     OVS_ACQ_RDLOCK((*rule)->up.evict);
  90
  91 bool rule_dpif_lookup_in_table(struct ofproto_dpif *, const struct flow *,
  92                                struct flow_wildcards *, uint8_t table_id,
  93                                struct rule_dpif **rule)
  94     OVS_ACQ_RDLOCK((*rule)->up.evict);
  95
  96 void rule_release(struct rule_dpif *rule) OVS_RELEASES(rule->up.evict);
  97
  98 void rule_credit_stats(struct rule_dpif *, const struct dpif_flow_stats *);
  99
 100 struct rule_dpif *choose_miss_rule(enum ofputil_port_config,
 101                                    struct rule_dpif *miss_rule,
 102                                    struct rule_dpif *no_packet_in_rule);
 103
 104 bool ofproto_has_vlan_splinters(const struct ofproto_dpif *);
 105 ofp_port_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
 106                                   ofp_port_t realdev_ofp_port,
 107                                   ovs_be16 vlan_tci);
 108 bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *);
 109
 110 void ofproto_dpif_send_packet_in(struct ofproto_dpif *,
 111                                  struct ofputil_packet_in *pin);
 112 void ofproto_dpif_flow_mod(struct ofproto_dpif *, struct ofputil_flow_mod *);
 113
 114 struct ofport_dpif *odp_port_to_ofport(const struct dpif_backer *, odp_port_t);
 115
 116 #endif /* ofproto-dpif.h */