datapath/datapath.h

   1 /*
   2  * Copyright (c) 2007-2012 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 "checksum.h"
  30 #include "compat.h"
  31 #include "flow.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  */
  52 struct dp_stats_percpu {
  53         u64 n_hit;
  54         u64 n_missed;
  55         u64 n_lost;
  56         struct u64_stats_sync sync;
  57 };
  58
  59 /**
  60  * struct datapath - datapath for flow-based packet switching
  61  * @rcu: RCU callback head for deferred destruction.
  62  * @list_node: Element in global 'dps' list.
  63  * @table: Current flow table.  Protected by ovs_mutex and RCU.
  64  * @ports: Hash table for ports.  %OVSP_LOCAL port always exists.  Protected by
  65  * ovs_mutex and RCU.
  66  * @stats_percpu: Per-CPU datapath statistics.
  67  * @net: Reference to net namespace.
  68  *
  69  * Context: See the comment on locking at the top of datapath.c for additional
  70  * locking information.
  71  */
  72 struct datapath {
  73         struct rcu_head rcu;
  74         struct list_head list_node;
  75
  76         /* Flow table. */
  77         struct flow_table __rcu *table;
  78
  79         /* Switch ports. */
  80         struct hlist_head *ports;
  81
  82         /* Stats. */
  83         struct dp_stats_percpu __percpu *stats_percpu;
  84
  85 #ifdef CONFIG_NET_NS
  86         /* Network namespace ref. */
  87         struct net *net;
  88 #endif
  89 };
  90
  91 /**
  92  * struct ovs_skb_cb - OVS data in skb CB
  93  * @flow: The flow associated with this packet.  May be %NULL if no flow.
  94  * @pkt_key: The flow information extracted from the packet.  Must be nonnull.
  95  * @tun_key: Key for the tunnel that encapsulated this packet. NULL if the
  96  * packet is not being tunneled.
  97  * @ip_summed: Consistently stores L4 checksumming status across different
  98  * kernel versions.
  99  * @csum_start: Stores the offset from which to start checksumming independent
 100  * of the transport header on all kernel versions.
 101  * packet was not received on a tunnel.
 102  * @vlan_tci: Provides a substitute for the skb->vlan_tci field on kernels
 103  * before 2.6.27.
 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 #ifdef NEED_CSUM_NORMALIZE
 110         enum csum_type          ip_summed;
 111         u16                     csum_start;
 112 #endif
 113 #ifdef NEED_VLAN_FIELD
 114         u16                     vlan_tci;
 115 #endif
 116 };
 117 #define OVS_CB(skb) ((struct ovs_skb_cb *)(skb)->cb)
 118
 119 /**
 120  * struct dp_upcall - metadata to include with a packet to send to userspace
 121  * @cmd: One of %OVS_PACKET_CMD_*.
 122  * @key: Becomes %OVS_PACKET_ATTR_KEY.  Must be nonnull.
 123  * @userdata: If nonnull, its variable-length value is passed to userspace as
 124  * %OVS_PACKET_ATTR_USERDATA.
 125  * @portid: Netlink PID to which packet should be sent.  If @portid is 0 then no
 126  * packet is sent and the packet is accounted in the datapath's @n_lost
 127  * counter.
 128  */
 129 struct dp_upcall_info {
 130         u8 cmd;
 131         const struct sw_flow_key *key;
 132         const struct nlattr *userdata;
 133         u32 portid;
 134 };
 135
 136 /**
 137  * struct ovs_net - Per net-namespace data for ovs.
 138  * @dps: List of datapaths to enable dumping them all out.
 139  * Protected by genl_mutex.
 140  * @vport_net: Per network namespace data for vport.
 141  */
 142 struct ovs_net {
 143         struct list_head dps;
 144         struct vport_net vport_net;
 145         struct work_struct dp_notify_work;
 146 };
 147
 148 extern int ovs_net_id;
 149 void ovs_lock(void);
 150 void ovs_unlock(void);
 151
 152 #ifdef CONFIG_LOCKDEP
 153 int lockdep_ovsl_is_held(void);
 154 #else
 155 #define lockdep_ovsl_is_held()  1
 156 #endif
 157
 158 #define ASSERT_OVSL()           WARN_ON(unlikely(!lockdep_ovsl_is_held()))
 159 #define ovsl_dereference(p)                                     \
 160         rcu_dereference_protected(p, lockdep_ovsl_is_held())
 161
 162 static inline struct net *ovs_dp_get_net(struct datapath *dp)
 163 {
 164         return read_pnet(&dp->net);
 165 }
 166
 167 static inline void ovs_dp_set_net(struct datapath *dp, struct net *net)
 168 {
 169         write_pnet(&dp->net, net);
 170 }
 171
 172 struct vport *ovs_lookup_vport(const struct datapath *dp, u16 port_no);
 173
 174 static inline struct vport *ovs_vport_rcu(const struct datapath *dp, int port_no)
 175 {
 176         WARN_ON_ONCE(!rcu_read_lock_held());
 177         return ovs_lookup_vport(dp, port_no);
 178 }
 179
 180 static inline struct vport *ovs_vport_ovsl_rcu(const struct datapath *dp, int port_no)
 181 {
 182         WARN_ON_ONCE(!rcu_read_lock_held() && !lockdep_ovsl_is_held());
 183         return ovs_lookup_vport(dp, port_no);
 184 }
 185
 186 static inline struct vport *ovs_vport_ovsl(const struct datapath *dp, int port_no)
 187 {
 188         ASSERT_OVSL();
 189         return ovs_lookup_vport(dp, port_no);
 190 }
 191
 192 extern struct notifier_block ovs_dp_device_notifier;
 193 extern struct genl_multicast_group ovs_dp_vport_multicast_group;
 194
 195 void ovs_dp_process_received_packet(struct vport *, struct sk_buff *);
 196 void ovs_dp_detach_port(struct vport *);
 197 int ovs_dp_upcall(struct datapath *, struct sk_buff *,
 198                   const struct dp_upcall_info *);
 199
 200 const char *ovs_dp_name(const struct datapath *dp);
 201 struct sk_buff *ovs_vport_cmd_build_info(struct vport *, u32 portid, u32 seq,
 202                                          u8 cmd);
 203
 204 int ovs_execute_actions(struct datapath *dp, struct sk_buff *skb);
 205 void ovs_dp_notify_wq(struct work_struct *work);
 206
 207 #define OVS_NLERR(fmt, ...) \
 208         pr_info_once("netlink: " fmt, ##__VA_ARGS__)
 209
 210 #endif /* datapath.h */