Commit | Line | Data |
---|---|---|
c9422999 | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
ccb1352e | 2 | /* |
caf2ee14 | 3 | * Copyright (c) 2007-2012 Nicira, Inc. |
ccb1352e JG |
4 | */ |
5 | ||
6 | #ifndef VPORT_H | |
7 | #define VPORT_H 1 | |
8 | ||
e0f0ecf3 | 9 | #include <linux/if_tunnel.h> |
ccb1352e | 10 | #include <linux/list.h> |
46df7b81 | 11 | #include <linux/netlink.h> |
ccb1352e | 12 | #include <linux/openvswitch.h> |
5cd667b0 | 13 | #include <linux/reciprocal_div.h> |
ccb1352e JG |
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 | ||
f4477305 | 23 | /* The following definitions are for users of the vport subsystem: */ |
ccb1352e JG |
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 | ||
12eb18f7 | 31 | struct vport *ovs_vport_locate(const struct net *net, const char *name); |
ccb1352e JG |
32 | |
33 | void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *); | |
34 | ||
1933ea36 | 35 | int ovs_vport_get_upcall_stats(struct vport *vport, struct sk_buff *skb); |
36 | ||
ccb1352e JG |
37 | int ovs_vport_set_options(struct vport *, struct nlattr *options); |
38 | int ovs_vport_get_options(const struct vport *, struct sk_buff *); | |
39 | ||
12eb18f7 | 40 | int ovs_vport_set_upcall_portids(struct vport *, const struct nlattr *pids); |
5cd667b0 AW |
41 | int ovs_vport_get_upcall_portids(const struct vport *, struct sk_buff *); |
42 | u32 ovs_vport_find_upcall_portid(const struct vport *, struct sk_buff *); | |
43 | ||
5cd667b0 AW |
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 | */ | |
53 | struct vport_portids { | |
54 | struct reciprocal_value rn_ids; | |
55 | struct rcu_head rcu; | |
56 | u32 n_ids; | |
57 | u32 ids[]; | |
58 | }; | |
ccb1352e JG |
59 | |
60 | /** | |
61 | * struct vport - one port within a datapath | |
c5420eb1 | 62 | * @dev: Pointer to net_device. |
e7c8ab84 | 63 | * @dev_tracker: refcount tracker for @dev reference |
ccb1352e | 64 | * @dp: Datapath to which this port belongs. |
5cd667b0 | 65 | * @upcall_portids: RCU protected 'struct vport_portids'. |
03599c94 | 66 | * @port_no: Index into @dp's @ports array. |
ccb1352e | 67 | * @hash_node: Element in @dev_table hash table in vport.c. |
15eac2a7 | 68 | * @dp_hash_node: Element in @datapath->ports hash table in datapath.c. |
ccb1352e | 69 | * @ops: Class structure. |
1933ea36 | 70 | * @upcall_stats: Upcall stats of every ports. |
7b4577a9 | 71 | * @detach_list: list used for detaching vport in net-exit call. |
c5420eb1 | 72 | * @rcu: RCU callback head for deferred destruction. |
ccb1352e JG |
73 | */ |
74 | struct vport { | |
be4ace6e | 75 | struct net_device *dev; |
e7c8ab84 | 76 | netdevice_tracker dev_tracker; |
ccb1352e | 77 | struct datapath *dp; |
5cd667b0 | 78 | struct vport_portids __rcu *upcall_portids; |
03599c94 | 79 | u16 port_no; |
ccb1352e JG |
80 | |
81 | struct hlist_node hash_node; | |
15eac2a7 | 82 | struct hlist_node dp_hash_node; |
ccb1352e | 83 | const struct vport_ops *ops; |
1933ea36 | 84 | struct vport_upcall_stats_percpu __percpu *upcall_stats; |
ccb1352e | 85 | |
7b4577a9 | 86 | struct list_head detach_list; |
be4ace6e | 87 | struct rcu_head rcu; |
ccb1352e JG |
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. | |
54c4ef34 | 97 | * @desired_ifindex: New vport's ifindex. |
ccb1352e JG |
98 | * @dp: New vport's datapath. |
99 | * @port_no: New vport's port number. | |
100 | */ | |
101 | struct vport_parms { | |
102 | const char *name; | |
103 | enum ovs_vport_type type; | |
54c4ef34 | 104 | int desired_ifindex; |
ccb1352e JG |
105 | struct nlattr *options; |
106 | ||
107 | /* For ovs_vport_alloc(). */ | |
108 | struct datapath *dp; | |
109 | u16 port_no; | |
5cd667b0 | 110 | struct nlattr *upcall_portids; |
ccb1352e JG |
111 | }; |
112 | ||
113 | /** | |
114 | * struct vport_ops - definition of a type of virtual port | |
115 | * | |
116 | * @type: %OVS_VPORT_TYPE_* value for this type of virtual port. | |
117 | * @create: Create a new vport configured as specified. On success returns | |
118 | * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value. | |
119 | * @destroy: Destroys a vport. Must call vport_free() on the vport but not | |
120 | * before an RCU grace period has elapsed. | |
121 | * @set_options: Modify the configuration of an existing vport. May be %NULL | |
122 | * if modification is not supported. | |
123 | * @get_options: Appends vport-specific attributes for the configuration of an | |
124 | * existing vport to a &struct sk_buff. May be %NULL for a vport that does not | |
125 | * have any configuration. | |
8c876639 | 126 | * @send: Send a packet on the device. |
91b7514c | 127 | * zero for dropped packets or negative for error. |
ccb1352e JG |
128 | */ |
129 | struct vport_ops { | |
130 | enum ovs_vport_type type; | |
131 | ||
8e4e1713 | 132 | /* Called with ovs_mutex. */ |
ccb1352e JG |
133 | struct vport *(*create)(const struct vport_parms *); |
134 | void (*destroy)(struct vport *); | |
135 | ||
136 | int (*set_options)(struct vport *, struct nlattr *); | |
137 | int (*get_options)(const struct vport *, struct sk_buff *); | |
138 | ||
8bb7c4f8 | 139 | int (*send)(struct sk_buff *skb); |
62b9c8d0 TG |
140 | struct module *owner; |
141 | struct list_head list; | |
ccb1352e JG |
142 | }; |
143 | ||
1933ea36 | 144 | /** |
145 | * struct vport_upcall_stats_percpu - per-cpu packet upcall statistics for | |
146 | * a given vport. | |
147 | * @n_success: Number of packets that upcall to userspace succeed. | |
148 | * @n_fail: Number of packets that upcall to userspace failed. | |
149 | */ | |
150 | struct vport_upcall_stats_percpu { | |
151 | struct u64_stats_sync syncp; | |
152 | u64_stats_t n_success; | |
153 | u64_stats_t n_fail; | |
154 | }; | |
155 | ||
ccb1352e JG |
156 | struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *, |
157 | const struct vport_parms *); | |
158 | void ovs_vport_free(struct vport *); | |
159 | ||
160 | #define VPORT_ALIGN 8 | |
161 | ||
162 | /** | |
163 | * vport_priv - access private data area of vport | |
164 | * | |
165 | * @vport: vport to access | |
166 | * | |
167 | * If a nonzero size was passed in priv_size of vport_alloc() a private data | |
168 | * area was allocated on creation. This allows that area to be accessed and | |
169 | * used for any purpose needed by the vport implementer. | |
170 | */ | |
171 | static inline void *vport_priv(const struct vport *vport) | |
172 | { | |
07dc0602 | 173 | return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN); |
ccb1352e JG |
174 | } |
175 | ||
176 | /** | |
177 | * vport_from_priv - lookup vport from private data pointer | |
178 | * | |
179 | * @priv: Start of private data area. | |
180 | * | |
181 | * It is sometimes useful to translate from a pointer to the private data | |
182 | * area to the vport, such as in the case where the private data pointer is | |
183 | * the result of a hash table lookup. @priv must point to the start of the | |
184 | * private data area. | |
185 | */ | |
d0b4da13 | 186 | static inline struct vport *vport_from_priv(void *priv) |
ccb1352e | 187 | { |
d0b4da13 | 188 | return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN)); |
ccb1352e JG |
189 | } |
190 | ||
8c876639 PS |
191 | int ovs_vport_receive(struct vport *, struct sk_buff *, |
192 | const struct ip_tunnel_info *); | |
ccb1352e | 193 | |
c9db965c TG |
194 | static inline const char *ovs_vport_name(struct vport *vport) |
195 | { | |
24d43f32 | 196 | return vport->dev->name; |
c9db965c TG |
197 | } |
198 | ||
83e4bf7a PA |
199 | int __ovs_vport_ops_register(struct vport_ops *ops); |
200 | #define ovs_vport_ops_register(ops) \ | |
201 | ({ \ | |
202 | (ops)->owner = THIS_MODULE; \ | |
203 | __ovs_vport_ops_register(ops); \ | |
204 | }) | |
205 | ||
62b9c8d0 | 206 | void ovs_vport_ops_unregister(struct vport_ops *ops); |
e2d9d835 | 207 | void ovs_vport_send(struct vport *vport, struct sk_buff *skb, u8 mac_proto); |
8c876639 | 208 | |
ccb1352e | 209 | #endif /* vport.h */ |