1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * Copyright (c) 2007-2012 Nicira, Inc.
4 */
5
6 #ifndef VPORT_H
7 #define VPORT_H 1
8
9 #include <linux/if_tunnel.h>
10 #include <linux/list.h>
11 #include <linux/netlink.h>
12 #include <linux/openvswitch.h>
13 #include <linux/reciprocal_div.h>
14 #include <linux/skbuff.h>
15 #include <linux/spinlock.h>
16 #include <linux/u64_stats_sync.h>
17
18 #include "datapath.h"
19
20 struct vport;
21 struct vport_parms;
22
23 /* The following definitions are for users of the vport subsystem: */
24
25 int ovs_vport_init(void);
26 void ovs_vport_exit(void);
27
28 struct vport *ovs_vport_add(const struct vport_parms *);
29 void ovs_vport_del(struct vport *);
30
31 struct vport *ovs_vport_locate(const struct net *net, const char *name);
32
33 void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *);
34
35 int ovs_vport_get_upcall_stats(struct vport *vport, struct sk_buff *skb);
36
37 int ovs_vport_set_upcall_portids(struct vport *, const struct nlattr *pids);
38 int ovs_vport_get_upcall_portids(const struct vport *, struct sk_buff *);
39 u32 ovs_vport_find_upcall_portid(const struct vport *, struct sk_buff *);
40
41 /**
42 * struct vport_portids - array of netlink portids of a vport.
43 * must be protected by rcu.
44 * @rn_ids: The reciprocal value of @n_ids.
45 * @rcu: RCU callback head for deferred destruction.
46 * @n_ids: Size of @ids array.
47 * @ids: Array storing the Netlink socket pids to be used for packets received
48 * on this port that miss the flow table.
49 */
50 struct vport_portids {
51 struct reciprocal_value rn_ids;
52 struct rcu_head rcu;
53 u32 n_ids;
54 u32 ids[];
55 };
56
57 /**
58 * struct vport - one port within a datapath
59 * @dev: Pointer to net_device.
60 * @dev_tracker: refcount tracker for @dev reference
61 * @dp: Datapath to which this port belongs.
62 * @upcall_portids: RCU protected 'struct vport_portids'.
63 * @port_no: Index into @dp's @ports array.
64 * @hash_node: Element in @dev_table hash table in vport.c.
65 * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
66 * @ops: Class structure.
67 * @upcall_stats: Upcall stats of every ports.
68 * @detach_list: list used for detaching vport in net-exit call.
69 * @rcu: RCU callback head for deferred destruction.
70 */
71 struct vport {
72 struct net_device *dev;
73 netdevice_tracker dev_tracker;
74 struct datapath *dp;
75 struct vport_portids __rcu *upcall_portids;
76 u16 port_no;
77
78 struct hlist_node hash_node;
79 struct hlist_node dp_hash_node;
80 const struct vport_ops *ops;
81 struct vport_upcall_stats_percpu __percpu *upcall_stats;
82
83 struct list_head detach_list;
84 struct rcu_head rcu;
85 };
86
87 /**
88 * struct vport_parms - parameters for creating a new vport
89 *
90 * @name: New vport's name.
91 * @type: New vport's type.
92 * @desired_ifindex: New vport's ifindex.
93 * @dp: New vport's datapath.
94 * @port_no: New vport's port number.
95 * @upcall_portids: %OVS_VPORT_ATTR_UPCALL_PID attribute from Netlink message,
96 * %NULL if none was supplied.
97 */
98 struct vport_parms {
99 const char *name;
100 enum ovs_vport_type type;
101 int desired_ifindex;
102
103 /* For ovs_vport_alloc(). */
104 struct datapath *dp;
105 u16 port_no;
106 struct nlattr *upcall_portids;
107 };
108
109 /**
110 * struct vport_ops - definition of a type of virtual port
111 *
112 * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
113 * @create: Create a new vport configured as specified. On success returns
114 * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
115 * @destroy: Destroys a vport. Must call vport_free() on the vport but not
116 * before an RCU grace period has elapsed.
117 * @send: Send a packet on the device.
118 * zero for dropped packets or negative for error.
119 * @list: List entry in the global list of vport types.
120 */
121 struct vport_ops {
122 enum ovs_vport_type type;
123
124 /* Called with ovs_mutex. */
125 struct vport *(*create)(const struct vport_parms *);
126 void (*destroy)(struct vport *);
127
128 int (*send)(struct sk_buff *skb);
129 struct list_head list;
130 };
131
132 /**
133 * struct vport_upcall_stats_percpu - per-cpu packet upcall statistics for
134 * a given vport.
135 * @syncp: Synchronization point for 64bit counters.
136 * @n_success: Number of packets that upcall to userspace succeed.
137 * @n_fail: Number of packets that upcall to userspace failed.
138 */
139 struct vport_upcall_stats_percpu {
140 struct u64_stats_sync syncp;
141 u64_stats_t n_success;
142 u64_stats_t n_fail;
143 };
144
145 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
146 const struct vport_parms *);
147 void ovs_vport_free(struct vport *);
148
149 #define VPORT_ALIGN 8
150
151 /**
152 * vport_priv - access private data area of vport
153 *
154 * @vport: vport to access
155 *
156 * Returns: A void pointer to a private data allocated in the @vport.
157 *
158 * If a nonzero size was passed in priv_size of vport_alloc() a private data
159 * area was allocated on creation. This allows that area to be accessed and
160 * used for any purpose needed by the vport implementer.
161 */
vport_priv(const struct vport * vport)162 static inline void *vport_priv(const struct vport *vport)
163 {
164 return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
165 }
166
167 /**
168 * vport_from_priv - lookup vport from private data pointer
169 *
170 * @priv: Start of private data area.
171 *
172 * Returns: A reference to a vport structure that contains @priv.
173 *
174 * It is sometimes useful to translate from a pointer to the private data
175 * area to the vport, such as in the case where the private data pointer is
176 * the result of a hash table lookup. @priv must point to the start of the
177 * private data area.
178 */
vport_from_priv(void * priv)179 static inline struct vport *vport_from_priv(void *priv)
180 {
181 return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
182 }
183
184 int ovs_vport_receive(struct vport *, struct sk_buff *,
185 const struct ip_tunnel_info *);
186
ovs_vport_name(struct vport * vport)187 static inline const char *ovs_vport_name(struct vport *vport)
188 {
189 return vport->dev->name;
190 }
191
192 int ovs_vport_ops_register(struct vport_ops *ops);
193
194 void ovs_vport_ops_unregister(struct vport_ops *ops);
195 void ovs_vport_send(struct vport *vport, struct sk_buff *skb, u8 mac_proto);
196
197 #endif /* vport.h */
198