vport.h

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