datapath/datapath.h

   1 /*
   2  * Copyright (c) 2007-2014 Nicira, Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of version 2 of the GNU General Public
   6  * License as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  16  * 02110-1301, USA
  17  */
  18
  19 #ifndef DATAPATH_H
  20 #define DATAPATH_H 1
  21
  22 #include <asm/page.h>
  23 #include <linux/kernel.h>
  24 #include <linux/mutex.h>
  25 #include <linux/netdevice.h>
  26 #include <linux/skbuff.h>
  27 #include <linux/u64_stats_sync.h>
  28
  29 #include "compat.h"
  30 #include "flow.h"
  31 #include "flow_table.h"
  32 #include "vlan.h"
  33 #include "vport.h"
  34
  35 #define DP_MAX_PORTS            USHRT_MAX
  36 #define DP_VPORT_HASH_BUCKETS   1024
  37
  38 #define SAMPLE_ACTION_DEPTH 3
  39
  40 /**
  41  * struct dp_stats_percpu - per-cpu packet processing statistics for a given
  42  * datapath.
  43  * @n_hit: Number of received packets for which a matching flow was found in
  44  * the flow table.
  45  * @n_miss: Number of received packets that had no matching flow in the flow
  46  * table.  The sum of @n_hit and @n_miss is the number of packets that have
  47  * been received by the datapath.
  48  * @n_lost: Number of received packets that had no matching flow in the flow
  49  * table that could not be sent to userspace (normally due to an overflow in
  50  * one of the datapath's queues).
  51  * @n_mask_hit: Number of masks looked up for flow match.
  52  *   @n_mask_hit / (@n_hit + @n_missed)  will be the average masks looked
  53  *   up per packet.
  54  */
  55 struct dp_stats_percpu {
  56         u64 n_hit;
  57         u64 n_missed;
  58         u64 n_lost;
  59         u64 n_mask_hit;
  60         struct u64_stats_sync sync;
  61 };
  62
  63 /**
  64  * struct datapath - datapath for flow-based packet switching
  65  * @rcu: RCU callback head for deferred destruction.
  66  * @list_node: Element in global 'dps' list.
  67  * @table: flow table.
  68  * @ports: Hash table for ports.  %OVSP_LOCAL port always exists.  Protected by
  69  * ovs_mutex and RCU.
  70  * @stats_percpu: Per-CPU datapath statistics.
  71  * @net: Reference to net namespace.
  72  *
  73  * Context: See the comment on locking at the top of datapath.c for additional
  74  * locking information.
  75  */
  76 struct datapath {
  77         struct rcu_head rcu;
  78         struct list_head list_node;
  79
  80         /* Flow table. */
  81         struct flow_table table;
  82
  83         /* Switch ports. */
  84         struct hlist_head *ports;
  85
  86         /* Stats. */
  87         struct dp_stats_percpu __percpu *stats_percpu;
  88
  89 #ifdef CONFIG_NET_NS
  90         /* Network namespace ref. */
  91         struct net *net;
  92 #endif
  93
  94         u32 user_features;
  95 };
  96
  97 /**
  98  * struct ovs_skb_cb - OVS data in skb CB
  99  * @flow: The flow associated with this packet.  May be %NULL if no flow.
 100  * @pkt_key: The flow information extracted from the packet.  Must be nonnull.
 101  * @tun_key: Key for the tunnel that encapsulated this packet. NULL if the
 102  * @input_vport: The original vport packet came in on. This value is cached
 103  * when a packet is received by OVS.
 104  */
 105 struct ovs_skb_cb {
 106         struct sw_flow          *flow;
 107         struct sw_flow_key      *pkt_key;
 108         struct ovs_key_ipv4_tunnel  *tun_key;
 109         struct vport    *input_vport;
 110 };
 111 #define OVS_CB(skb) ((struct ovs_skb_cb *)(skb)->cb)
 112
 113 /**
 114  * struct dp_upcall - metadata to include with a packet to send to userspace
 115  * @cmd: One of %OVS_PACKET_CMD_*.
 116  * @key: Becomes %OVS_PACKET_ATTR_KEY.  Must be nonnull.
 117  * @userdata: If nonnull, its variable-length value is passed to userspace as
 118  * %OVS_PACKET_ATTR_USERDATA.
 119  * @portid: Netlink PID to which packet should be sent.  If @portid is 0 then no
 120  * packet is sent and the packet is accounted in the datapath's @n_lost
 121  * counter.
 122  */
 123 struct dp_upcall_info {
 124         u8 cmd;
 125         const struct sw_flow_key *key;
 126         const struct nlattr *userdata;
 127         u32 portid;
 128 };
 129
 130 /**
 131  * struct ovs_net - Per net-namespace data for ovs.
 132  * @dps: List of datapaths to enable dumping them all out.
 133  * Protected by genl_mutex.
 134  * @vport_net: Per network namespace data for vport.
 135  */
 136 struct ovs_net {
 137         struct list_head dps;
 138         struct vport_net vport_net;
 139         struct work_struct dp_notify_work;
 140 };
 141
 142 extern int ovs_net_id;
 143 void ovs_lock(void);
 144 void ovs_unlock(void);
 145
 146 #ifdef CONFIG_LOCKDEP
 147 int lockdep_ovsl_is_held(void);
 148 #else
 149 #define lockdep_ovsl_is_held()  1
 150 #endif
 151
 152 #define ASSERT_OVSL()           WARN_ON(unlikely(!lockdep_ovsl_is_held()))
 153 #define ovsl_dereference(p)                                     \
 154         rcu_dereference_protected(p, lockdep_ovsl_is_held())
 155 #define rcu_dereference_ovsl(p)                                 \
 156         rcu_dereference_check(p, lockdep_ovsl_is_held())
 157
 158 static inline struct net *ovs_dp_get_net(struct datapath *dp)
 159 {
 160         return read_pnet(&dp->net);
 161 }
 162
 163 static inline void ovs_dp_set_net(struct datapath *dp, struct net *net)
 164 {
 165         write_pnet(&dp->net, net);
 166 }
 167
 168 struct vport *ovs_lookup_vport(const struct datapath *dp, u16 port_no);
 169
 170 static inline struct vport *ovs_vport_rcu(const struct datapath *dp, int port_no)
 171 {
 172         WARN_ON_ONCE(!rcu_read_lock_held());
 173         return ovs_lookup_vport(dp, port_no);
 174 }
 175
 176 static inline struct vport *ovs_vport_ovsl_rcu(const struct datapath *dp, int port_no)
 177 {
 178         WARN_ON_ONCE(!rcu_read_lock_held() && !lockdep_ovsl_is_held());
 179         return ovs_lookup_vport(dp, port_no);
 180 }
 181
 182 static inline struct vport *ovs_vport_ovsl(const struct datapath *dp, int port_no)
 183 {
 184         ASSERT_OVSL();
 185         return ovs_lookup_vport(dp, port_no);
 186 }
 187
 188 extern struct notifier_block ovs_dp_device_notifier;
 189 extern struct genl_family dp_vport_genl_family;
 190 extern struct genl_multicast_group ovs_dp_vport_multicast_group;
 191
 192 void ovs_dp_process_received_packet(struct vport *, struct sk_buff *);
 193 void ovs_dp_process_packet_with_key(struct sk_buff *,
 194                                     struct sw_flow_key *pkt_key);
 195 void ovs_dp_detach_port(struct vport *);
 196 int ovs_dp_upcall(struct datapath *, struct sk_buff *,
 197                   const struct dp_upcall_info *);
 198
 199 const char *ovs_dp_name(const struct datapath *dp);
 200 struct sk_buff *ovs_vport_cmd_build_info(struct vport *, u32 portid, u32 seq,
 201                                          u8 cmd);
 202
 203 int ovs_execute_actions(struct datapath *dp, struct sk_buff *skb);
 204 void ovs_dp_notify_wq(struct work_struct *work);
 205
 206 #define OVS_NLERR(fmt, ...)                                     \
 207 do {                                                            \
 208         if (net_ratelimit())                                    \
 209                 pr_info("netlink: " fmt, ##__VA_ARGS__);        \
 210 } while (0)
 211 #endif /* datapath.h */