Loading...
1/*
2 * Copyright (c) 2007-2011 Nicira Networks.
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 "flow.h"
30
31struct vport;
32
33#define DP_MAX_PORTS 1024
34#define SAMPLE_ACTION_DEPTH 3
35
36/**
37 * struct dp_stats_percpu - per-cpu packet processing statistics for a given
38 * datapath.
39 * @n_hit: Number of received packets for which a matching flow was found in
40 * the flow table.
41 * @n_miss: Number of received packets that had no matching flow in the flow
42 * table. The sum of @n_hit and @n_miss is the number of packets that have
43 * been received by the datapath.
44 * @n_lost: Number of received packets that had no matching flow in the flow
45 * table that could not be sent to userspace (normally due to an overflow in
46 * one of the datapath's queues).
47 */
48struct dp_stats_percpu {
49 u64 n_hit;
50 u64 n_missed;
51 u64 n_lost;
52 struct u64_stats_sync sync;
53};
54
55/**
56 * struct datapath - datapath for flow-based packet switching
57 * @rcu: RCU callback head for deferred destruction.
58 * @list_node: Element in global 'dps' list.
59 * @n_flows: Number of flows currently in flow table.
60 * @table: Current flow table. Protected by genl_lock and RCU.
61 * @ports: Map from port number to &struct vport. %OVSP_LOCAL port
62 * always exists, other ports may be %NULL. Protected by RTNL and RCU.
63 * @port_list: List of all ports in @ports in arbitrary order. RTNL required
64 * to iterate or modify.
65 * @stats_percpu: Per-CPU datapath statistics.
66 *
67 * Context: See the comment on locking at the top of datapath.c for additional
68 * locking information.
69 */
70struct datapath {
71 struct rcu_head rcu;
72 struct list_head list_node;
73
74 /* Flow table. */
75 struct flow_table __rcu *table;
76
77 /* Switch ports. */
78 struct vport __rcu *ports[DP_MAX_PORTS];
79 struct list_head port_list;
80
81 /* Stats. */
82 struct dp_stats_percpu __percpu *stats_percpu;
83};
84
85/**
86 * struct ovs_skb_cb - OVS data in skb CB
87 * @flow: The flow associated with this packet. May be %NULL if no flow.
88 */
89struct ovs_skb_cb {
90 struct sw_flow *flow;
91};
92#define OVS_CB(skb) ((struct ovs_skb_cb *)(skb)->cb)
93
94/**
95 * struct dp_upcall - metadata to include with a packet to send to userspace
96 * @cmd: One of %OVS_PACKET_CMD_*.
97 * @key: Becomes %OVS_PACKET_ATTR_KEY. Must be nonnull.
98 * @userdata: If nonnull, its u64 value is extracted and passed to userspace as
99 * %OVS_PACKET_ATTR_USERDATA.
100 * @pid: Netlink PID to which packet should be sent. If @pid is 0 then no
101 * packet is sent and the packet is accounted in the datapath's @n_lost
102 * counter.
103 */
104struct dp_upcall_info {
105 u8 cmd;
106 const struct sw_flow_key *key;
107 const struct nlattr *userdata;
108 u32 pid;
109};
110
111extern struct notifier_block ovs_dp_device_notifier;
112extern struct genl_multicast_group ovs_dp_vport_multicast_group;
113
114void ovs_dp_process_received_packet(struct vport *, struct sk_buff *);
115void ovs_dp_detach_port(struct vport *);
116int ovs_dp_upcall(struct datapath *, struct sk_buff *,
117 const struct dp_upcall_info *);
118
119const char *ovs_dp_name(const struct datapath *dp);
120struct sk_buff *ovs_vport_cmd_build_info(struct vport *, u32 pid, u32 seq,
121 u8 cmd);
122
123int ovs_execute_actions(struct datapath *dp, struct sk_buff *skb);
124#endif /* 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 "flow.h"
30#include "flow_table.h"
31#include "vport.h"
32
33#define DP_MAX_PORTS USHRT_MAX
34#define DP_VPORT_HASH_BUCKETS 1024
35
36#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).
49 * @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.
52 */
53struct dp_stats_percpu {
54 u64 n_hit;
55 u64 n_missed;
56 u64 n_lost;
57 u64 n_mask_hit;
58 struct u64_stats_sync syncp;
59};
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.
65 * @table: flow table.
66 * @ports: Hash table for ports. %OVSP_LOCAL port always exists. Protected by
67 * ovs_mutex and RCU.
68 * @stats_percpu: Per-CPU datapath statistics.
69 * @net: Reference to net namespace.
70 *
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. */
79 struct flow_table table;
80
81 /* Switch ports. */
82 struct hlist_head *ports;
83
84 /* Stats. */
85 struct dp_stats_percpu __percpu *stats_percpu;
86
87#ifdef CONFIG_NET_NS
88 /* Network namespace ref. */
89 struct net *net;
90#endif
91
92 u32 user_features;
93};
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.
98 * @pkt_key: The flow information extracted from the packet. Must be nonnull.
99 * @tun_key: Key for the tunnel that encapsulated this packet. NULL if the
100 * packet is not being tunneled.
101 */
102struct ovs_skb_cb {
103 struct sw_flow *flow;
104 struct sw_flow_key *pkt_key;
105 struct ovs_key_ipv4_tunnel *tun_key;
106};
107#define OVS_CB(skb) ((struct ovs_skb_cb *)(skb)->cb)
108
109/**
110 * struct dp_upcall - metadata to include with a packet to send to userspace
111 * @cmd: One of %OVS_PACKET_CMD_*.
112 * @key: Becomes %OVS_PACKET_ATTR_KEY. Must be nonnull.
113 * @userdata: If nonnull, its variable-length value is passed to userspace as
114 * %OVS_PACKET_ATTR_USERDATA.
115 * @pid: Netlink PID to which packet should be sent. If @pid is 0 then no
116 * packet is sent and the packet is accounted in the datapath's @n_lost
117 * counter.
118 */
119struct dp_upcall_info {
120 u8 cmd;
121 const struct sw_flow_key *key;
122 const struct nlattr *userdata;
123 u32 portid;
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 */
131struct ovs_net {
132 struct list_head dps;
133 struct work_struct dp_notify_work;
134 struct vport_net vport_net;
135};
136
137extern int ovs_net_id;
138void ovs_lock(void);
139void ovs_unlock(void);
140
141#ifdef CONFIG_LOCKDEP
142int lockdep_ovsl_is_held(void);
143#else
144#define lockdep_ovsl_is_held() 1
145#endif
146
147#define ASSERT_OVSL() WARN_ON(unlikely(!lockdep_ovsl_is_held()))
148#define ovsl_dereference(p) \
149 rcu_dereference_protected(p, lockdep_ovsl_is_held())
150#define rcu_dereference_ovsl(p) \
151 rcu_dereference_check(p, lockdep_ovsl_is_held())
152
153static inline struct net *ovs_dp_get_net(struct datapath *dp)
154{
155 return read_pnet(&dp->net);
156}
157
158static inline void ovs_dp_set_net(struct datapath *dp, struct net *net)
159{
160 write_pnet(&dp->net, net);
161}
162
163struct vport *ovs_lookup_vport(const struct datapath *dp, u16 port_no);
164
165static inline struct vport *ovs_vport_rcu(const struct datapath *dp, int port_no)
166{
167 WARN_ON_ONCE(!rcu_read_lock_held());
168 return ovs_lookup_vport(dp, port_no);
169}
170
171static inline struct vport *ovs_vport_ovsl_rcu(const struct datapath *dp, int port_no)
172{
173 WARN_ON_ONCE(!rcu_read_lock_held() && !lockdep_ovsl_is_held());
174 return ovs_lookup_vport(dp, port_no);
175}
176
177static inline struct vport *ovs_vport_ovsl(const struct datapath *dp, int port_no)
178{
179 ASSERT_OVSL();
180 return ovs_lookup_vport(dp, port_no);
181}
182
183extern struct notifier_block ovs_dp_device_notifier;
184extern struct genl_family dp_vport_genl_family;
185
186void ovs_dp_process_received_packet(struct vport *, struct sk_buff *);
187void ovs_dp_detach_port(struct vport *);
188int ovs_dp_upcall(struct datapath *, struct sk_buff *,
189 const struct dp_upcall_info *);
190
191struct sk_buff *ovs_vport_cmd_build_info(struct vport *, u32 pid, u32 seq,
192 u8 cmd);
193
194int ovs_execute_actions(struct datapath *dp, struct sk_buff *skb);
195void ovs_dp_notify_wq(struct work_struct *work);
196
197#define OVS_NLERR(fmt, ...) \
198 pr_info_once("netlink: " fmt, ##__VA_ARGS__)
199
200#endif /* datapath.h */