blob: ac3f3df96961f9d4956db5f8fa9d54d41b4f3b3b [file] [log] [blame]
Jesse Grossccb13522011-10-25 19:26:31 -07001/*
Andy Zhou971427f32014-09-15 19:37:25 -07002 * Copyright (c) 2007-2014 Nicira, Inc.
Jesse Grossccb13522011-10-25 19:26:31 -07003 *
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>
Jesse Grossccb13522011-10-25 19:26:31 -070028
29#include "flow.h"
Pravin B Shelare6445712013-10-03 18:16:47 -070030#include "flow_table.h"
Pravin B Shelar46df7b82012-02-22 19:58:59 -080031#include "vport.h"
Jesse Grossccb13522011-10-25 19:26:31 -070032
Pravin B Shelar15eac2a2012-08-23 12:40:54 -070033#define DP_MAX_PORTS USHRT_MAX
34#define DP_VPORT_HASH_BUCKETS 1024
35
Jesse Grossccb13522011-10-25 19:26:31 -070036#define SAMPLE_ACTION_DEPTH 3
37
38/**
39 * struct dp_stats_percpu - per-cpu packet processing statistics for a given
40 * datapath.
41 * @n_hit: Number of received packets for which a matching flow was found in
42 * the flow table.
43 * @n_miss: Number of received packets that had no matching flow in the flow
44 * table. The sum of @n_hit and @n_miss is the number of packets that have
45 * been received by the datapath.
46 * @n_lost: Number of received packets that had no matching flow in the flow
47 * table that could not be sent to userspace (normally due to an overflow in
48 * one of the datapath's queues).
Andy Zhou1bd71162013-10-22 10:42:46 -070049 * @n_mask_hit: Number of masks looked up for flow match.
50 * @n_mask_hit / (@n_hit + @n_missed) will be the average masks looked
51 * up per packet.
Jesse Grossccb13522011-10-25 19:26:31 -070052 */
53struct dp_stats_percpu {
54 u64 n_hit;
55 u64 n_missed;
56 u64 n_lost;
Andy Zhou1bd71162013-10-22 10:42:46 -070057 u64 n_mask_hit;
WANG Congdf9d9fd2014-02-14 15:10:46 -080058 struct u64_stats_sync syncp;
Jesse Grossccb13522011-10-25 19:26:31 -070059};
60
61/**
62 * struct datapath - datapath for flow-based packet switching
63 * @rcu: RCU callback head for deferred destruction.
64 * @list_node: Element in global 'dps' list.
Pravin B Shelarb637e492013-10-04 00:14:23 -070065 * @table: flow table.
Pravin B Shelar15eac2a2012-08-23 12:40:54 -070066 * @ports: Hash table for ports. %OVSP_LOCAL port always exists. Protected by
Pravin B Shelar8e4e1712013-04-15 13:23:03 -070067 * ovs_mutex and RCU.
Jesse Grossccb13522011-10-25 19:26:31 -070068 * @stats_percpu: Per-CPU datapath statistics.
Pravin B Shelar46df7b82012-02-22 19:58:59 -080069 * @net: Reference to net namespace.
Jesse Grossccb13522011-10-25 19:26:31 -070070 *
71 * Context: See the comment on locking at the top of datapath.c for additional
72 * locking information.
73 */
74struct datapath {
75 struct rcu_head rcu;
76 struct list_head list_node;
77
78 /* Flow table. */
Pravin B Shelarb637e492013-10-04 00:14:23 -070079 struct flow_table table;
Jesse Grossccb13522011-10-25 19:26:31 -070080
81 /* Switch ports. */
Pravin B Shelar15eac2a2012-08-23 12:40:54 -070082 struct hlist_head *ports;
Jesse Grossccb13522011-10-25 19:26:31 -070083
84 /* Stats. */
85 struct dp_stats_percpu __percpu *stats_percpu;
Pravin B Shelar46df7b82012-02-22 19:58:59 -080086
87#ifdef CONFIG_NET_NS
88 /* Network namespace ref. */
89 struct net *net;
90#endif
Thomas Graf43d4be92013-12-13 15:22:18 +010091
92 u32 user_features;
Jesse Grossccb13522011-10-25 19:26:31 -070093};
94
95/**
96 * struct ovs_skb_cb - OVS data in skb CB
97 * @flow: The flow associated with this packet. May be %NULL if no flow.
Pravin B Shelar8c8b1b82014-09-15 19:28:44 -070098 * @egress_tun_key: Tunnel information about this packet on egress path.
99 * NULL if the packet is not being tunneled.
Pravin B Shelar83c8df22014-09-15 19:20:31 -0700100 * @input_vport: The original vport packet came in on. This value is cached
101 * when a packet is received by OVS.
Jesse Grossccb13522011-10-25 19:26:31 -0700102 */
103struct ovs_skb_cb {
104 struct sw_flow *flow;
Pravin B Shelar83c8df22014-09-15 19:20:31 -0700105 struct vport *input_vport;
Pravin B Shelar8c8b1b82014-09-15 19:28:44 -0700106 struct ovs_key_ipv4_tunnel *egress_tun_key;
Jesse Grossccb13522011-10-25 19:26:31 -0700107};
108#define OVS_CB(skb) ((struct ovs_skb_cb *)(skb)->cb)
109
110/**
111 * struct dp_upcall - metadata to include with a packet to send to userspace
112 * @cmd: One of %OVS_PACKET_CMD_*.
113 * @key: Becomes %OVS_PACKET_ATTR_KEY. Must be nonnull.
Ben Pfaff44901082013-02-15 17:29:22 -0800114 * @userdata: If nonnull, its variable-length value is passed to userspace as
Jesse Grossccb13522011-10-25 19:26:31 -0700115 * %OVS_PACKET_ATTR_USERDATA.
116 * @pid: Netlink PID to which packet should be sent. If @pid is 0 then no
117 * packet is sent and the packet is accounted in the datapath's @n_lost
118 * counter.
119 */
120struct dp_upcall_info {
121 u8 cmd;
122 const struct sw_flow_key *key;
123 const struct nlattr *userdata;
Eric W. Biederman15e47302012-09-07 20:12:54 +0000124 u32 portid;
Jesse Grossccb13522011-10-25 19:26:31 -0700125};
126
Pravin B Shelar8e4e1712013-04-15 13:23:03 -0700127/**
128 * struct ovs_net - Per net-namespace data for ovs.
129 * @dps: List of datapaths to enable dumping them all out.
130 * Protected by genl_mutex.
131 */
132struct ovs_net {
133 struct list_head dps;
134 struct work_struct dp_notify_work;
Pravin B Shelaraa310702013-06-17 17:50:33 -0700135 struct vport_net vport_net;
Pravin B Shelar8e4e1712013-04-15 13:23:03 -0700136};
137
138extern int ovs_net_id;
139void ovs_lock(void);
140void ovs_unlock(void);
141
142#ifdef CONFIG_LOCKDEP
143int lockdep_ovsl_is_held(void);
144#else
145#define lockdep_ovsl_is_held() 1
146#endif
147
Thomas Graf80019d32014-07-30 02:31:08 +0200148#define ASSERT_OVSL() WARN_ON(!lockdep_ovsl_is_held())
Pravin B Shelar8e4e1712013-04-15 13:23:03 -0700149#define ovsl_dereference(p) \
150 rcu_dereference_protected(p, lockdep_ovsl_is_held())
Jesse Gross663efa32013-12-03 10:58:53 -0800151#define rcu_dereference_ovsl(p) \
152 rcu_dereference_check(p, lockdep_ovsl_is_held())
Pravin B Shelar8e4e1712013-04-15 13:23:03 -0700153
Pravin B Shelar46df7b82012-02-22 19:58:59 -0800154static inline struct net *ovs_dp_get_net(struct datapath *dp)
155{
156 return read_pnet(&dp->net);
157}
158
159static inline void ovs_dp_set_net(struct datapath *dp, struct net *net)
160{
161 write_pnet(&dp->net, net);
162}
163
Pravin B Shelar8e4e1712013-04-15 13:23:03 -0700164struct vport *ovs_lookup_vport(const struct datapath *dp, u16 port_no);
165
166static inline struct vport *ovs_vport_rcu(const struct datapath *dp, int port_no)
167{
168 WARN_ON_ONCE(!rcu_read_lock_held());
169 return ovs_lookup_vport(dp, port_no);
170}
171
172static inline struct vport *ovs_vport_ovsl_rcu(const struct datapath *dp, int port_no)
173{
174 WARN_ON_ONCE(!rcu_read_lock_held() && !lockdep_ovsl_is_held());
175 return ovs_lookup_vport(dp, port_no);
176}
177
178static inline struct vport *ovs_vport_ovsl(const struct datapath *dp, int port_no)
179{
180 ASSERT_OVSL();
181 return ovs_lookup_vport(dp, port_no);
182}
183
Jesse Grossccb13522011-10-25 19:26:31 -0700184extern struct notifier_block ovs_dp_device_notifier;
Johannes Berg68eb5502013-11-19 15:19:38 +0100185extern struct genl_family dp_vport_genl_family;
Jesse Grossccb13522011-10-25 19:26:31 -0700186
Pravin B Shelar8c8b1b82014-09-15 19:28:44 -0700187void ovs_dp_process_packet(struct sk_buff *skb, struct sw_flow_key *key);
Jesse Grossccb13522011-10-25 19:26:31 -0700188void ovs_dp_detach_port(struct vport *);
189int ovs_dp_upcall(struct datapath *, struct sk_buff *,
190 const struct dp_upcall_info *);
191
Andy Zhou971427f32014-09-15 19:37:25 -0700192const char *ovs_dp_name(const struct datapath *dp);
Jesse Grossccb13522011-10-25 19:26:31 -0700193struct sk_buff *ovs_vport_cmd_build_info(struct vport *, u32 pid, u32 seq,
194 u8 cmd);
195
Pravin B Shelar2ff3e4e2014-09-15 19:15:28 -0700196int ovs_execute_actions(struct datapath *dp, struct sk_buff *skb,
197 struct sw_flow_key *);
Andy Zhou971427f32014-09-15 19:37:25 -0700198
Pravin B Shelar8e4e1712013-04-15 13:23:03 -0700199void ovs_dp_notify_wq(struct work_struct *work);
Andy Zhou03f0d912013-08-07 20:01:00 -0700200
Andy Zhou971427f32014-09-15 19:37:25 -0700201int action_fifos_init(void);
202void action_fifos_exit(void);
203
Joe Perches1815a882014-02-03 17:06:46 -0800204#define OVS_NLERR(fmt, ...) \
205do { \
206 if (net_ratelimit()) \
207 pr_info("netlink: " fmt, ##__VA_ARGS__); \
208} while (0)
Jesse Grossccb13522011-10-25 19:26:31 -0700209#endif /* datapath.h */