ofproto/ofproto-dpif.h

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