Loading...
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#include <net/ip_tunnels.h>
29
30#include "conntrack.h"
31#include "flow.h"
32#include "flow_table.h"
33#include "meter.h"
34#include "vport-internal_dev.h"
35
36#define DP_MAX_PORTS USHRT_MAX
37#define DP_VPORT_HASH_BUCKETS 1024
38
39/**
40 * struct dp_stats_percpu - per-cpu packet processing statistics for a given
41 * datapath.
42 * @n_hit: Number of received packets for which a matching flow was found in
43 * the flow table.
44 * @n_miss: Number of received packets that had no matching flow in the flow
45 * table. The sum of @n_hit and @n_miss is the number of packets that have
46 * been received by the datapath.
47 * @n_lost: Number of received packets that had no matching flow in the flow
48 * table that could not be sent to userspace (normally due to an overflow in
49 * one of the datapath's queues).
50 * @n_mask_hit: Number of masks looked up for flow match.
51 * @n_mask_hit / (@n_hit + @n_missed) will be the average masks looked
52 * up per packet.
53 */
54struct dp_stats_percpu {
55 u64 n_hit;
56 u64 n_missed;
57 u64 n_lost;
58 u64 n_mask_hit;
59 struct u64_stats_sync syncp;
60};
61
62/**
63 * struct datapath - datapath for flow-based packet switching
64 * @rcu: RCU callback head for deferred destruction.
65 * @list_node: Element in global 'dps' list.
66 * @table: flow table.
67 * @ports: Hash table for ports. %OVSP_LOCAL port always exists. Protected by
68 * ovs_mutex and RCU.
69 * @stats_percpu: Per-CPU datapath statistics.
70 * @net: Reference to net namespace.
71 * @max_headroom: the maximum headroom of all vports in this datapath; it will
72 * be used by all the internal vports in this dp.
73 *
74 * Context: See the comment on locking at the top of datapath.c for additional
75 * locking information.
76 */
77struct 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 u32 max_headroom;
96
97 /* Switch meters. */
98 struct hlist_head *meters;
99};
100
101/**
102 * struct ovs_skb_cb - OVS data in skb CB
103 * @input_vport: The original vport packet came in on. This value is cached
104 * when a packet is received by OVS.
105 * @mru: The maximum received fragement size; 0 if the packet is not
106 * fragmented.
107 * @acts_origlen: The netlink size of the flow actions applied to this skb.
108 * @cutlen: The number of bytes from the packet end to be removed.
109 */
110struct ovs_skb_cb {
111 struct vport *input_vport;
112 u16 mru;
113 u16 acts_origlen;
114 u32 cutlen;
115};
116#define OVS_CB(skb) ((struct ovs_skb_cb *)(skb)->cb)
117
118/**
119 * struct dp_upcall - metadata to include with a packet to send to userspace
120 * @cmd: One of %OVS_PACKET_CMD_*.
121 * @userdata: If nonnull, its variable-length value is passed to userspace as
122 * %OVS_PACKET_ATTR_USERDATA.
123 * @portid: Netlink portid to which packet should be sent. If @portid is 0
124 * then no packet is sent and the packet is accounted in the datapath's @n_lost
125 * counter.
126 * @egress_tun_info: If nonnull, becomes %OVS_PACKET_ATTR_EGRESS_TUN_KEY.
127 * @mru: If not zero, Maximum received IP fragment size.
128 */
129struct dp_upcall_info {
130 struct ip_tunnel_info *egress_tun_info;
131 const struct nlattr *userdata;
132 const struct nlattr *actions;
133 int actions_len;
134 u32 portid;
135 u8 cmd;
136 u16 mru;
137};
138
139/**
140 * struct ovs_net - Per net-namespace data for ovs.
141 * @dps: List of datapaths to enable dumping them all out.
142 * Protected by genl_mutex.
143 */
144struct ovs_net {
145 struct list_head dps;
146 struct work_struct dp_notify_work;
147
148 /* Module reference for configuring conntrack. */
149 bool xt_label;
150};
151
152extern unsigned int ovs_net_id;
153void ovs_lock(void);
154void ovs_unlock(void);
155
156#ifdef CONFIG_LOCKDEP
157int lockdep_ovsl_is_held(void);
158#else
159#define lockdep_ovsl_is_held() 1
160#endif
161
162#define ASSERT_OVSL() WARN_ON(!lockdep_ovsl_is_held())
163#define ovsl_dereference(p) \
164 rcu_dereference_protected(p, lockdep_ovsl_is_held())
165#define rcu_dereference_ovsl(p) \
166 rcu_dereference_check(p, lockdep_ovsl_is_held())
167
168static inline struct net *ovs_dp_get_net(const struct datapath *dp)
169{
170 return read_pnet(&dp->net);
171}
172
173static inline void ovs_dp_set_net(struct datapath *dp, struct net *net)
174{
175 write_pnet(&dp->net, net);
176}
177
178struct vport *ovs_lookup_vport(const struct datapath *dp, u16 port_no);
179
180static inline struct vport *ovs_vport_rcu(const struct datapath *dp, int port_no)
181{
182 WARN_ON_ONCE(!rcu_read_lock_held());
183 return ovs_lookup_vport(dp, port_no);
184}
185
186static inline struct vport *ovs_vport_ovsl_rcu(const struct datapath *dp, int port_no)
187{
188 WARN_ON_ONCE(!rcu_read_lock_held() && !lockdep_ovsl_is_held());
189 return ovs_lookup_vport(dp, port_no);
190}
191
192static inline struct vport *ovs_vport_ovsl(const struct datapath *dp, int port_no)
193{
194 ASSERT_OVSL();
195 return ovs_lookup_vport(dp, port_no);
196}
197
198/* Must be called with rcu_read_lock. */
199static inline struct datapath *get_dp_rcu(struct net *net, int dp_ifindex)
200{
201 struct net_device *dev = dev_get_by_index_rcu(net, dp_ifindex);
202
203 if (dev) {
204 struct vport *vport = ovs_internal_dev_get_vport(dev);
205
206 if (vport)
207 return vport->dp;
208 }
209
210 return NULL;
211}
212
213/* The caller must hold either ovs_mutex or rcu_read_lock to keep the
214 * returned dp pointer valid.
215 */
216static inline struct datapath *get_dp(struct net *net, int dp_ifindex)
217{
218 struct datapath *dp;
219
220 WARN_ON_ONCE(!rcu_read_lock_held() && !lockdep_ovsl_is_held());
221 rcu_read_lock();
222 dp = get_dp_rcu(net, dp_ifindex);
223 rcu_read_unlock();
224
225 return dp;
226}
227
228extern struct notifier_block ovs_dp_device_notifier;
229extern struct genl_family dp_vport_genl_family;
230
231void ovs_dp_process_packet(struct sk_buff *skb, struct sw_flow_key *key);
232void ovs_dp_detach_port(struct vport *);
233int ovs_dp_upcall(struct datapath *, struct sk_buff *,
234 const struct sw_flow_key *, const struct dp_upcall_info *,
235 uint32_t cutlen);
236
237const char *ovs_dp_name(const struct datapath *dp);
238struct sk_buff *ovs_vport_cmd_build_info(struct vport *vport, struct net *net,
239 u32 portid, u32 seq, u8 cmd);
240
241int ovs_execute_actions(struct datapath *dp, struct sk_buff *skb,
242 const struct sw_flow_actions *, struct sw_flow_key *);
243
244void ovs_dp_notify_wq(struct work_struct *work);
245
246int action_fifos_init(void);
247void action_fifos_exit(void);
248
249/* 'KEY' must not have any bits set outside of the 'MASK' */
250#define OVS_MASKED(OLD, KEY, MASK) ((KEY) | ((OLD) & ~(MASK)))
251#define OVS_SET_MASKED(OLD, KEY, MASK) ((OLD) = OVS_MASKED(OLD, KEY, MASK))
252
253#define OVS_NLERR(logging_allowed, fmt, ...) \
254do { \
255 if (logging_allowed && net_ratelimit()) \
256 pr_info("netlink: " fmt "\n", ##__VA_ARGS__); \
257} while (0)
258#endif /* datapath.h */
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Copyright (c) 2007-2014 Nicira, Inc.
4 */
5
6#ifndef DATAPATH_H
7#define DATAPATH_H 1
8
9#include <asm/page.h>
10#include <linux/kernel.h>
11#include <linux/mutex.h>
12#include <linux/netdevice.h>
13#include <linux/skbuff.h>
14#include <linux/u64_stats_sync.h>
15#include <net/ip_tunnels.h>
16
17#include "conntrack.h"
18#include "flow.h"
19#include "flow_table.h"
20#include "meter.h"
21#include "vport-internal_dev.h"
22
23#define DP_MAX_PORTS USHRT_MAX
24#define DP_VPORT_HASH_BUCKETS 1024
25#define DP_MASKS_REBALANCE_INTERVAL 4000
26
27/**
28 * struct dp_stats_percpu - per-cpu packet processing statistics for a given
29 * datapath.
30 * @n_hit: Number of received packets for which a matching flow was found in
31 * the flow table.
32 * @n_miss: Number of received packets that had no matching flow in the flow
33 * table. The sum of @n_hit and @n_miss is the number of packets that have
34 * been received by the datapath.
35 * @n_lost: Number of received packets that had no matching flow in the flow
36 * table that could not be sent to userspace (normally due to an overflow in
37 * one of the datapath's queues).
38 * @n_mask_hit: Number of masks looked up for flow match.
39 * @n_mask_hit / (@n_hit + @n_missed) will be the average masks looked
40 * up per packet.
41 * @n_cache_hit: The number of received packets that had their mask found using
42 * the mask cache.
43 */
44struct dp_stats_percpu {
45 u64 n_hit;
46 u64 n_missed;
47 u64 n_lost;
48 u64 n_mask_hit;
49 u64 n_cache_hit;
50 struct u64_stats_sync syncp;
51};
52
53/**
54 * struct dp_nlsk_pids - array of netlink portids of for a datapath.
55 * This is used when OVS_DP_F_DISPATCH_UPCALL_PER_CPU
56 * is enabled and must be protected by rcu.
57 * @rcu: RCU callback head for deferred destruction.
58 * @n_pids: Size of @pids array.
59 * @pids: Array storing the Netlink socket PIDs indexed by CPU ID for packets
60 * that miss the flow table.
61 */
62struct dp_nlsk_pids {
63 struct rcu_head rcu;
64 u32 n_pids;
65 u32 pids[];
66};
67
68/**
69 * struct datapath - datapath for flow-based packet switching
70 * @rcu: RCU callback head for deferred destruction.
71 * @list_node: Element in global 'dps' list.
72 * @table: flow table.
73 * @ports: Hash table for ports. %OVSP_LOCAL port always exists. Protected by
74 * ovs_mutex and RCU.
75 * @stats_percpu: Per-CPU datapath statistics.
76 * @net: Reference to net namespace.
77 * @max_headroom: the maximum headroom of all vports in this datapath; it will
78 * be used by all the internal vports in this dp.
79 * @upcall_portids: RCU protected 'struct dp_nlsk_pids'.
80 *
81 * Context: See the comment on locking at the top of datapath.c for additional
82 * locking information.
83 */
84struct datapath {
85 struct rcu_head rcu;
86 struct list_head list_node;
87
88 /* Flow table. */
89 struct flow_table table;
90
91 /* Switch ports. */
92 struct hlist_head *ports;
93
94 /* Stats. */
95 struct dp_stats_percpu __percpu *stats_percpu;
96
97 /* Network namespace ref. */
98 possible_net_t net;
99
100 u32 user_features;
101
102 u32 max_headroom;
103
104 /* Switch meters. */
105 struct dp_meter_table meter_tbl;
106
107 struct dp_nlsk_pids __rcu *upcall_portids;
108};
109
110/**
111 * struct ovs_skb_cb - OVS data in skb CB
112 * @input_vport: The original vport packet came in on. This value is cached
113 * when a packet is received by OVS.
114 * @mru: The maximum received fragement size; 0 if the packet is not
115 * fragmented.
116 * @acts_origlen: The netlink size of the flow actions applied to this skb.
117 * @cutlen: The number of bytes from the packet end to be removed.
118 */
119struct ovs_skb_cb {
120 struct vport *input_vport;
121 u16 mru;
122 u16 acts_origlen;
123 u32 cutlen;
124};
125#define OVS_CB(skb) ((struct ovs_skb_cb *)(skb)->cb)
126
127/**
128 * struct dp_upcall - metadata to include with a packet to send to userspace
129 * @cmd: One of %OVS_PACKET_CMD_*.
130 * @userdata: If nonnull, its variable-length value is passed to userspace as
131 * %OVS_PACKET_ATTR_USERDATA.
132 * @portid: Netlink portid to which packet should be sent. If @portid is 0
133 * then no packet is sent and the packet is accounted in the datapath's @n_lost
134 * counter.
135 * @egress_tun_info: If nonnull, becomes %OVS_PACKET_ATTR_EGRESS_TUN_KEY.
136 * @mru: If not zero, Maximum received IP fragment size.
137 */
138struct dp_upcall_info {
139 struct ip_tunnel_info *egress_tun_info;
140 const struct nlattr *userdata;
141 const struct nlattr *actions;
142 int actions_len;
143 u32 portid;
144 u8 cmd;
145 u16 mru;
146};
147
148/**
149 * struct ovs_net - Per net-namespace data for ovs.
150 * @dps: List of datapaths to enable dumping them all out.
151 * Protected by genl_mutex.
152 */
153struct ovs_net {
154 struct list_head dps;
155 struct work_struct dp_notify_work;
156 struct delayed_work masks_rebalance;
157#if IS_ENABLED(CONFIG_NETFILTER_CONNCOUNT)
158 struct ovs_ct_limit_info *ct_limit_info;
159#endif
160
161 /* Module reference for configuring conntrack. */
162 bool xt_label;
163};
164
165/**
166 * enum ovs_pkt_hash_types - hash info to include with a packet
167 * to send to userspace.
168 * @OVS_PACKET_HASH_SW_BIT: indicates hash was computed in software stack.
169 * @OVS_PACKET_HASH_L4_BIT: indicates hash is a canonical 4-tuple hash
170 * over transport ports.
171 */
172enum ovs_pkt_hash_types {
173 OVS_PACKET_HASH_SW_BIT = (1ULL << 32),
174 OVS_PACKET_HASH_L4_BIT = (1ULL << 33),
175};
176
177extern unsigned int ovs_net_id;
178void ovs_lock(void);
179void ovs_unlock(void);
180
181#ifdef CONFIG_LOCKDEP
182int lockdep_ovsl_is_held(void);
183#else
184#define lockdep_ovsl_is_held() 1
185#endif
186
187#define ASSERT_OVSL() WARN_ON(!lockdep_ovsl_is_held())
188#define ovsl_dereference(p) \
189 rcu_dereference_protected(p, lockdep_ovsl_is_held())
190#define rcu_dereference_ovsl(p) \
191 rcu_dereference_check(p, lockdep_ovsl_is_held())
192
193static inline struct net *ovs_dp_get_net(const struct datapath *dp)
194{
195 return read_pnet(&dp->net);
196}
197
198static inline void ovs_dp_set_net(struct datapath *dp, struct net *net)
199{
200 write_pnet(&dp->net, net);
201}
202
203struct vport *ovs_lookup_vport(const struct datapath *dp, u16 port_no);
204
205static inline struct vport *ovs_vport_rcu(const struct datapath *dp, int port_no)
206{
207 WARN_ON_ONCE(!rcu_read_lock_held());
208 return ovs_lookup_vport(dp, port_no);
209}
210
211static inline struct vport *ovs_vport_ovsl_rcu(const struct datapath *dp, int port_no)
212{
213 WARN_ON_ONCE(!rcu_read_lock_held() && !lockdep_ovsl_is_held());
214 return ovs_lookup_vport(dp, port_no);
215}
216
217static inline struct vport *ovs_vport_ovsl(const struct datapath *dp, int port_no)
218{
219 ASSERT_OVSL();
220 return ovs_lookup_vport(dp, port_no);
221}
222
223/* Must be called with rcu_read_lock. */
224static inline struct datapath *get_dp_rcu(struct net *net, int dp_ifindex)
225{
226 struct net_device *dev = dev_get_by_index_rcu(net, dp_ifindex);
227
228 if (dev) {
229 struct vport *vport = ovs_internal_dev_get_vport(dev);
230
231 if (vport)
232 return vport->dp;
233 }
234
235 return NULL;
236}
237
238/* The caller must hold either ovs_mutex or rcu_read_lock to keep the
239 * returned dp pointer valid.
240 */
241static inline struct datapath *get_dp(struct net *net, int dp_ifindex)
242{
243 struct datapath *dp;
244
245 WARN_ON_ONCE(!rcu_read_lock_held() && !lockdep_ovsl_is_held());
246 rcu_read_lock();
247 dp = get_dp_rcu(net, dp_ifindex);
248 rcu_read_unlock();
249
250 return dp;
251}
252
253extern struct notifier_block ovs_dp_device_notifier;
254extern struct genl_family dp_vport_genl_family;
255
256void ovs_dp_process_packet(struct sk_buff *skb, struct sw_flow_key *key);
257void ovs_dp_detach_port(struct vport *);
258int ovs_dp_upcall(struct datapath *, struct sk_buff *,
259 const struct sw_flow_key *, const struct dp_upcall_info *,
260 uint32_t cutlen);
261
262u32 ovs_dp_get_upcall_portid(const struct datapath *dp, uint32_t cpu_id);
263
264const char *ovs_dp_name(const struct datapath *dp);
265struct sk_buff *ovs_vport_cmd_build_info(struct vport *vport, struct net *net,
266 u32 portid, u32 seq, u8 cmd);
267
268int ovs_execute_actions(struct datapath *dp, struct sk_buff *skb,
269 const struct sw_flow_actions *, struct sw_flow_key *);
270
271void ovs_dp_notify_wq(struct work_struct *work);
272
273int action_fifos_init(void);
274void action_fifos_exit(void);
275
276/* 'KEY' must not have any bits set outside of the 'MASK' */
277#define OVS_MASKED(OLD, KEY, MASK) ((KEY) | ((OLD) & ~(MASK)))
278#define OVS_SET_MASKED(OLD, KEY, MASK) ((OLD) = OVS_MASKED(OLD, KEY, MASK))
279
280#define OVS_NLERR(logging_allowed, fmt, ...) \
281do { \
282 if (logging_allowed && net_ratelimit()) \
283 pr_info("netlink: " fmt "\n", ##__VA_ARGS__); \
284} while (0)
285#endif /* datapath.h */