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 #include "vlan.h"
  35
  36 #define DP_MAX_PORTS           USHRT_MAX
  37 #define DP_VPORT_HASH_BUCKETS  1024
  38
  39 #define SAMPLE_ACTION_DEPTH 3
  40
  41 /**
  42  * struct dp_stats_percpu - per-cpu packet processing statistics for a given
  43  * datapath.
  44  * @n_hit: Number of received packets for which a matching flow was found in
  45  * the flow table.
  46  * @n_miss: Number of received packets that had no matching flow in the flow
  47  * table.  The sum of @n_hit and @n_miss is the number of packets that have
  48  * been received by the datapath.
  49  * @n_lost: Number of received packets that had no matching flow in the flow
  50  * table that could not be sent to userspace (normally due to an overflow in
  51  * one of the datapath's queues).
  52  * @n_mask_hit: Number of masks looked up for flow match.
  53  *   @n_mask_hit / (@n_hit + @n_missed)  will be the average masks looked
  54  *   up per packet.
  55  */
  56 struct dp_stats_percpu {
  57         u64 n_hit;
  58         u64 n_missed;
  59         u64 n_lost;
  60         u64 n_mask_hit;
  61         struct u64_stats_sync syncp;
  62 };
  63
  64 /**
  65  * struct datapath - datapath for flow-based packet switching
  66  * @rcu: RCU callback head for deferred destruction.
  67  * @list_node: Element in global 'dps' list.
  68  * @table: flow table.
  69  * @ports: Hash table for ports.  %OVSP_LOCAL port always exists.  Protected by
  70  * ovs_mutex and RCU.
  71  * @stats_percpu: Per-CPU datapath statistics.
  72  * @net: Reference to net namespace.
  73  *
  74  * Context: See the comment on locking at the top of datapath.c for additional
  75  * locking information.
  76  */
  77 struct datapath {
  78         struct rcu_head rcu;
  79         struct list_head list_node;
  80
  81         /* Flow table. */
  82         struct flow_table table;
  83
  84         /* Switch ports. */
  85         struct hlist_head *ports;
  86
  87         /* Stats. */
  88         struct dp_stats_percpu __percpu *stats_percpu;
  89
  90         /* Network namespace ref. */
  91         possible_net_t net;
  92
  93         u32 user_features;
  94 };
  95
  96 /**
  97  * struct ovs_skb_cb - OVS data in skb CB
  98  * @input_vport: The original vport packet came in on. This value is cached
  99  * when a packet is received by OVS.
 100  */
 101 struct ovs_skb_cb {
 102         struct vport            *input_vport;
 103 };
 104 #define OVS_CB(skb) ((struct ovs_skb_cb *)(skb)->cb)
 105
 106 /**
 107  * struct dp_upcall - metadata to include with a packet to send to userspace
 108  * @cmd: One of %OVS_PACKET_CMD_*.
 109  * @userdata: If nonnull, its variable-length value is passed to userspace as
 110  * %OVS_PACKET_ATTR_USERDATA.
 111  * @portid: Netlink portid to which packet should be sent.  If @portid is 0
 112  * then no packet is sent and the packet is accounted in the datapath's @n_lost
 113  * counter.
 114  * @egress_tun_info: If nonnull, becomes %OVS_PACKET_ATTR_EGRESS_TUN_KEY.
 115  */
 116 struct dp_upcall_info {
 117         struct ip_tunnel_info *egress_tun_info;
 118         const void *egress_tun_opts;
 119         const struct nlattr *userdata;
 120         const struct nlattr *actions;
 121         int actions_len;
 122         u32 portid;
 123         u8 cmd;
 124 };
 125
 126 /**
 127  * struct ovs_net - Per net-namespace data for ovs.
 128  * @dps: List of datapaths to enable dumping them all out.
 129  * Protected by genl_mutex.
 130  */
 131 struct ovs_net {
 132         struct list_head dps;
 133         struct work_struct dp_notify_work;
 134 };
 135
 136 extern int ovs_net_id;
 137 void ovs_lock(void);
 138 void ovs_unlock(void);
 139
 140 #ifdef CONFIG_LOCKDEP
 141 int lockdep_ovsl_is_held(void);
 142 #else
 143 #define lockdep_ovsl_is_held()  1
 144 #endif
 145
 146 #define ASSERT_OVSL()           WARN_ON(!lockdep_ovsl_is_held())
 147 #define ovsl_dereference(p)                                     \
 148         rcu_dereference_protected(p, lockdep_ovsl_is_held())
 149 #define rcu_dereference_ovsl(p)                                 \
 150         rcu_dereference_check(p, lockdep_ovsl_is_held())
 151
 152 static inline struct net *ovs_dp_get_net(const struct datapath *dp)
 153 {
 154         return rpl_read_pnet(&dp->net);
 155 }
 156
 157 static inline void ovs_dp_set_net(struct datapath *dp, struct net *net)
 158 {
 159         rpl_write_pnet(&dp->net, net);
 160 }
 161
 162 struct vport *ovs_lookup_vport(const struct datapath *dp, u16 port_no);
 163
 164 static inline struct vport *ovs_vport_rcu(const struct datapath *dp, int port_no)
 165 {
 166         WARN_ON_ONCE(!rcu_read_lock_held());
 167         return ovs_lookup_vport(dp, port_no);
 168 }
 169
 170 static inline struct vport *ovs_vport_ovsl_rcu(const struct datapath *dp, int port_no)
 171 {
 172         WARN_ON_ONCE(!rcu_read_lock_held() && !lockdep_ovsl_is_held());
 173         return ovs_lookup_vport(dp, port_no);
 174 }
 175
 176 static inline struct vport *ovs_vport_ovsl(const struct datapath *dp, int port_no)
 177 {
 178         ASSERT_OVSL();
 179         return ovs_lookup_vport(dp, port_no);
 180 }
 181
 182 extern struct notifier_block ovs_dp_device_notifier;
 183 extern struct genl_family dp_vport_genl_family;
 184 extern struct genl_multicast_group ovs_dp_vport_multicast_group;
 185
 186 void ovs_dp_process_packet(struct sk_buff *skb, struct sw_flow_key *key);
 187 void ovs_dp_detach_port(struct vport *);
 188 int ovs_dp_upcall(struct datapath *, struct sk_buff *,
 189                   const struct sw_flow_key *, const struct dp_upcall_info *);
 190
 191 const char *ovs_dp_name(const struct datapath *dp);
 192 struct sk_buff *ovs_vport_cmd_build_info(struct vport *, u32 pid, u32 seq,
 193                                          u8 cmd);
 194
 195 int ovs_execute_actions(struct datapath *dp, struct sk_buff *skb,
 196                         const struct sw_flow_actions *, struct sw_flow_key *);
 197
 198 void ovs_dp_notify_wq(struct work_struct *work);
 199
 200 int action_fifos_init(void);
 201 void action_fifos_exit(void);
 202
 203 #define OVS_NLERR(logging_allowed, fmt, ...)                    \
 204 do {                                                            \
 205         if (logging_allowed && net_ratelimit())                 \
 206                 pr_info("netlink: " fmt "\n", ##__VA_ARGS__);   \
 207 } while (0)
 208 #endif /* datapath.h */