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