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