datapath/datapath.h

   1 /*
   2  * Copyright (c) 2007-2015 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 #include <net/net_namespace.h>
  29 #include <net/ip_tunnels.h>
  30
  31 #include "compat.h"
  32 #include "flow.h"
  33 #include "flow_table.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 syncp;
  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  * @max_headroom: the maximum headroom of all vports in this datapath; it will
  73  * be used by all the internal vports in this dp.
  74  *
  75  * Context: See the comment on locking at the top of datapath.c for additional
  76  * locking information.
  77  */
  78 struct datapath {
  79         struct rcu_head rcu;
  80         struct list_head list_node;
  81
  82         /* Flow table. */
  83         struct flow_table table;
  84
  85         /* Switch ports. */
  86         struct hlist_head *ports;
  87
  88         /* Stats. */
  89         struct dp_stats_percpu __percpu *stats_percpu;
  90
  91         /* Network namespace ref. */
  92         possible_net_t net;
  93
  94         u32 user_features;
  95
  96         u32 max_headroom;
  97 };
  98
  99 /**
 100  * struct ovs_skb_cb - OVS data in skb CB
 101  * @input_vport: The original vport packet came in on. This value is cached
 102  * when a packet is received by OVS.
 103  * @mru: The maximum received fragement size; 0 if the packet is not
 104  * @cutlen: The number of bytes from the packet end to be removed.
 105  * fragmented.
 106  */
 107 struct ovs_skb_cb {
 108         struct vport            *input_vport;
 109         u16                     mru;
 110         u32                     cutlen;
 111 };
 112 #define OVS_CB(skb) ((struct ovs_skb_cb *)(skb)->cb)
 113
 114 /**
 115  * struct dp_upcall - metadata to include with a packet to send to userspace
 116  * @cmd: One of %OVS_PACKET_CMD_*.
 117  * @userdata: If nonnull, its variable-length value is passed to userspace as
 118  * %OVS_PACKET_ATTR_USERDATA.
 119  * @portid: Netlink portid to which packet should be sent.  If @portid is 0
 120  * then no packet is sent and the packet is accounted in the datapath's @n_lost
 121  * counter.
 122  * @egress_tun_info: If nonnull, becomes %OVS_PACKET_ATTR_EGRESS_TUN_KEY.
 123  * @mru: If not zero, Maximum received IP fragment size.
 124  */
 125 struct dp_upcall_info {
 126         struct ip_tunnel_info *egress_tun_info;
 127         const struct nlattr *userdata;
 128         const struct nlattr *actions;
 129         int actions_len;
 130         u32 portid;
 131         u8 cmd;
 132         u16 mru;
 133 };
 134
 135 /**
 136  * struct ovs_net - Per net-namespace data for ovs.
 137  * @dps: List of datapaths to enable dumping them all out.
 138  * Protected by genl_mutex.
 139  */
 140 struct ovs_net {
 141         struct list_head dps;
 142         struct work_struct dp_notify_work;
 143
 144         /* Module reference for configuring conntrack. */
 145         bool xt_label;
 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(!lockdep_ovsl_is_held())
 159 #define ovsl_dereference(p)                                     \
 160         rcu_dereference_protected(p, lockdep_ovsl_is_held())
 161 #define rcu_dereference_ovsl(p)                                 \
 162         rcu_dereference_check(p, lockdep_ovsl_is_held())
 163
 164 static inline struct net *ovs_dp_get_net(const struct datapath *dp)
 165 {
 166         return rpl_read_pnet(&dp->net);
 167 }
 168
 169 static inline void ovs_dp_set_net(struct datapath *dp, struct net *net)
 170 {
 171         rpl_write_pnet(&dp->net, net);
 172 }
 173
 174 struct vport *ovs_lookup_vport(const struct datapath *dp, u16 port_no);
 175
 176 static inline struct vport *ovs_vport_rcu(const struct datapath *dp, int port_no)
 177 {
 178         WARN_ON_ONCE(!rcu_read_lock_held());
 179         return ovs_lookup_vport(dp, port_no);
 180 }
 181
 182 static inline struct vport *ovs_vport_ovsl_rcu(const struct datapath *dp, int port_no)
 183 {
 184         WARN_ON_ONCE(!rcu_read_lock_held() && !lockdep_ovsl_is_held());
 185         return ovs_lookup_vport(dp, port_no);
 186 }
 187
 188 static inline struct vport *ovs_vport_ovsl(const struct datapath *dp, int port_no)
 189 {
 190         ASSERT_OVSL();
 191         return ovs_lookup_vport(dp, port_no);
 192 }
 193
 194 extern struct notifier_block ovs_dp_device_notifier;
 195 extern struct genl_family dp_vport_genl_family;
 196 extern struct genl_multicast_group ovs_dp_vport_multicast_group;
 197
 198 void ovs_dp_process_packet(struct sk_buff *skb, struct sw_flow_key *key);
 199 void ovs_dp_detach_port(struct vport *);
 200 int ovs_dp_upcall(struct datapath *, struct sk_buff *,
 201                   const struct sw_flow_key *, const struct dp_upcall_info *,
 202                   uint32_t cutlen);
 203
 204 const char *ovs_dp_name(const struct datapath *dp);
 205 struct sk_buff *ovs_vport_cmd_build_info(struct vport *, u32 pid, u32 seq,
 206                                          u8 cmd);
 207
 208 int ovs_execute_actions(struct datapath *dp, struct sk_buff *skb,
 209                         const struct sw_flow_actions *, struct sw_flow_key *);
 210
 211 void ovs_dp_notify_wq(struct work_struct *work);
 212
 213 int action_fifos_init(void);
 214 void action_fifos_exit(void);
 215
 216 /* 'KEY' must not have any bits set outside of the 'MASK' */
 217 #define OVS_MASKED(OLD, KEY, MASK) ((KEY) | ((OLD) & ~(MASK)))
 218 #define OVS_SET_MASKED(OLD, KEY, MASK) ((OLD) = OVS_MASKED(OLD, KEY, MASK))
 219
 220 #define OVS_NLERR(logging_allowed, fmt, ...)                    \
 221 do {                                                            \
 222         if (logging_allowed && net_ratelimit())                 \
 223                 pr_info("netlink: " fmt "\n", ##__VA_ARGS__);   \
 224 } while (0)
 225 #endif /* datapath.h */