]>
Commit | Line | Data |
---|---|---|
f2459fe7 | 1 | /* |
e0edde6f | 2 | * Copyright (c) 2007-2012 Nicira, Inc. |
f2459fe7 | 3 | * |
a9a29d22 JG |
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 | |
f2459fe7 JG |
17 | */ |
18 | ||
19 | #ifndef VPORT_H | |
20 | #define VPORT_H 1 | |
21 | ||
22 | #include <linux/list.h> | |
2a4999f3 | 23 | #include <linux/netlink.h> |
077257b8 | 24 | #include <linux/openvswitch.h> |
f2459fe7 JG |
25 | #include <linux/skbuff.h> |
26 | #include <linux/spinlock.h> | |
821cb9fa | 27 | #include <linux/u64_stats_sync.h> |
f2459fe7 | 28 | |
2a4999f3 | 29 | #include "vport-capwap.h" |
f2459fe7 JG |
30 | |
31 | struct vport; | |
94903c98 | 32 | struct vport_parms; |
f2459fe7 | 33 | |
2a4999f3 PS |
34 | struct vport_net { |
35 | struct capwap_net capwap; | |
36 | }; | |
37 | ||
f2459fe7 JG |
38 | /* The following definitions are for users of the vport subsytem: */ |
39 | ||
850b6b3b JG |
40 | int ovs_vport_init(void); |
41 | void ovs_vport_exit(void); | |
f2459fe7 | 42 | |
850b6b3b JG |
43 | struct vport *ovs_vport_add(const struct vport_parms *); |
44 | void ovs_vport_del(struct vport *); | |
f2459fe7 | 45 | |
2a4999f3 | 46 | struct vport *ovs_vport_locate(struct net *net, const char *name); |
f2459fe7 | 47 | |
850b6b3b JG |
48 | int ovs_vport_set_addr(struct vport *, const unsigned char *); |
49 | void ovs_vport_set_stats(struct vport *, struct ovs_vport_stats *); | |
50 | void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *); | |
f2459fe7 | 51 | |
850b6b3b JG |
52 | int ovs_vport_set_options(struct vport *, struct nlattr *options); |
53 | int ovs_vport_get_options(const struct vport *, struct sk_buff *); | |
f2459fe7 | 54 | |
850b6b3b | 55 | int ovs_vport_send(struct vport *, struct sk_buff *); |
f2459fe7 JG |
56 | |
57 | /* The following definitions are for implementers of vport devices: */ | |
58 | ||
59 | struct vport_percpu_stats { | |
60 | u64 rx_bytes; | |
61 | u64 rx_packets; | |
62 | u64 tx_bytes; | |
63 | u64 tx_packets; | |
821cb9fa | 64 | struct u64_stats_sync sync; |
f2459fe7 JG |
65 | }; |
66 | ||
67 | struct vport_err_stats { | |
f2459fe7 JG |
68 | u64 rx_dropped; |
69 | u64 rx_errors; | |
f2459fe7 JG |
70 | u64 tx_dropped; |
71 | u64 tx_errors; | |
f2459fe7 JG |
72 | }; |
73 | ||
e779d8d9 BP |
74 | /** |
75 | * struct vport - one port within a datapath | |
057dd6d2 | 76 | * @rcu: RCU callback head for deferred destruction. |
e779d8d9 BP |
77 | * @port_no: Index into @dp's @ports array. |
78 | * @dp: Datapath to which this port belongs. | |
79 | * @kobj: Represents /sys/class/net/<devname>/brport. | |
80 | * @linkname: The name of the link from /sys/class/net/<datapath>/brif to this | |
81 | * &struct vport. (We keep this around so that we can delete it if the | |
82 | * device gets renamed.) Set to the null string when no link exists. | |
b063d9f0 JG |
83 | * @upcall_pid: The Netlink port to use for packets received on this port that |
84 | * miss the flow table. | |
e779d8d9 | 85 | * @hash_node: Element in @dev_table hash table in vport.c. |
95b1d73a | 86 | * @dp_hash_node: Element in @datapath->ports hash table in datapath.c. |
e779d8d9 | 87 | * @ops: Class structure. |
f613a0d7 | 88 | * @percpu_stats: Points to per-CPU statistics used and maintained by vport |
e779d8d9 | 89 | * @stats_lock: Protects @err_stats and @offset_stats. |
f613a0d7 | 90 | * @err_stats: Points to error statistics used and maintained by vport |
e779d8d9 BP |
91 | * @offset_stats: Added to actual statistics as a sop to compatibility with |
92 | * XAPI for Citrix XenServer. Deprecated. | |
93 | */ | |
f2459fe7 | 94 | struct vport { |
057dd6d2 | 95 | struct rcu_head rcu; |
e779d8d9 BP |
96 | u16 port_no; |
97 | struct datapath *dp; | |
98 | struct kobject kobj; | |
99 | char linkname[IFNAMSIZ]; | |
b063d9f0 | 100 | u32 upcall_pid; |
e779d8d9 | 101 | |
f2459fe7 | 102 | struct hlist_node hash_node; |
95b1d73a | 103 | struct hlist_node dp_hash_node; |
f2459fe7 | 104 | const struct vport_ops *ops; |
f2459fe7 | 105 | |
d3097eff | 106 | struct vport_percpu_stats __percpu *percpu_stats; |
780e6207 JG |
107 | |
108 | spinlock_t stats_lock; | |
f2459fe7 | 109 | struct vport_err_stats err_stats; |
f613a0d7 | 110 | struct ovs_vport_stats offset_stats; |
f2459fe7 JG |
111 | }; |
112 | ||
113 | #define VPORT_F_REQUIRED (1 << 0) /* If init fails, module loading fails. */ | |
f613a0d7 PS |
114 | #define VPORT_F_FLOW (1 << 1) /* Sets OVS_CB(skb)->flow. */ |
115 | #define VPORT_F_TUN_ID (1 << 2) /* Sets OVS_CB(skb)->tun_id. */ | |
f2459fe7 | 116 | |
94903c98 BP |
117 | /** |
118 | * struct vport_parms - parameters for creating a new vport | |
119 | * | |
120 | * @name: New vport's name. | |
121 | * @type: New vport's type. | |
df2c07f4 | 122 | * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if |
c19e6535 | 123 | * none was supplied. |
e779d8d9 BP |
124 | * @dp: New vport's datapath. |
125 | * @port_no: New vport's port number. | |
94903c98 BP |
126 | */ |
127 | struct vport_parms { | |
128 | const char *name; | |
df2c07f4 | 129 | enum ovs_vport_type type; |
c19e6535 | 130 | struct nlattr *options; |
e779d8d9 | 131 | |
850b6b3b | 132 | /* For ovs_vport_alloc(). */ |
e779d8d9 BP |
133 | struct datapath *dp; |
134 | u16 port_no; | |
b063d9f0 | 135 | u32 upcall_pid; |
94903c98 BP |
136 | }; |
137 | ||
f2459fe7 JG |
138 | /** |
139 | * struct vport_ops - definition of a type of virtual port | |
140 | * | |
df2c07f4 | 141 | * @type: %OVS_VPORT_TYPE_* value for this type of virtual port. |
f2459fe7 JG |
142 | * @flags: Flags of type VPORT_F_* that influence how the generic vport layer |
143 | * handles this vport. | |
144 | * @init: Called at module initialization. If VPORT_F_REQUIRED is set then the | |
145 | * failure of this function will cause the module to not load. If the flag is | |
146 | * not set and initialzation fails then no vports of this type can be created. | |
147 | * @exit: Called at module unload. | |
94903c98 | 148 | * @create: Create a new vport configured as specified. On success returns |
850b6b3b | 149 | * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value. |
057dd6d2 BP |
150 | * @destroy: Destroys a vport. Must call vport_free() on the vport but not |
151 | * before an RCU grace period has elapsed. | |
c19e6535 BP |
152 | * @set_options: Modify the configuration of an existing vport. May be %NULL |
153 | * if modification is not supported. | |
154 | * @get_options: Appends vport-specific attributes for the configuration of an | |
155 | * existing vport to a &struct sk_buff. May be %NULL for a vport that does not | |
156 | * have any configuration. | |
f2459fe7 JG |
157 | * @set_addr: Set the device's MAC address. May be null if not supported. |
158 | * @get_name: Get the device's name. | |
159 | * @get_addr: Get the device's MAC address. | |
dd851cbb | 160 | * @get_config: Get the device's configuration. |
f2459fe7 | 161 | * @get_kobj: Get the kobj associated with the device (may return null). |
f2459fe7 JG |
162 | * @get_dev_flags: Get the device's flags. |
163 | * @is_running: Checks whether the device is running. | |
164 | * @get_operstate: Get the device's operating state. | |
165 | * @get_ifindex: Get the system interface index associated with the device. | |
166 | * May be null if the device does not have an ifindex. | |
f915f1a8 | 167 | * @get_mtu: Get the device's MTU. May be %NULL if the device does not have an |
16b82e84 JG |
168 | * MTU (as e.g. some tunnels do not). Must be implemented if @get_ifindex is |
169 | * implemented. | |
f2459fe7 JG |
170 | * @send: Send a packet on the device. Returns the length of the packet sent. |
171 | */ | |
172 | struct vport_ops { | |
df2c07f4 | 173 | enum ovs_vport_type type; |
f2459fe7 JG |
174 | u32 flags; |
175 | ||
176 | /* Called at module init and exit respectively. */ | |
177 | int (*init)(void); | |
178 | void (*exit)(void); | |
179 | ||
180 | /* Called with RTNL lock. */ | |
94903c98 | 181 | struct vport *(*create)(const struct vport_parms *); |
3544358a | 182 | void (*destroy)(struct vport *); |
f2459fe7 | 183 | |
c19e6535 BP |
184 | int (*set_options)(struct vport *, struct nlattr *); |
185 | int (*get_options)(const struct vport *, struct sk_buff *); | |
186 | ||
f2459fe7 JG |
187 | int (*set_addr)(struct vport *, const unsigned char *); |
188 | ||
189 | /* Called with rcu_read_lock or RTNL lock. */ | |
190 | const char *(*get_name)(const struct vport *); | |
191 | const unsigned char *(*get_addr)(const struct vport *); | |
dd851cbb | 192 | void (*get_config)(const struct vport *, void *); |
f2459fe7 | 193 | struct kobject *(*get_kobj)(const struct vport *); |
f2459fe7 JG |
194 | |
195 | unsigned (*get_dev_flags)(const struct vport *); | |
196 | int (*is_running)(const struct vport *); | |
197 | unsigned char (*get_operstate)(const struct vport *); | |
198 | ||
199 | int (*get_ifindex)(const struct vport *); | |
f2459fe7 JG |
200 | |
201 | int (*get_mtu)(const struct vport *); | |
202 | ||
203 | int (*send)(struct vport *, struct sk_buff *); | |
204 | }; | |
205 | ||
206 | enum vport_err_type { | |
207 | VPORT_E_RX_DROPPED, | |
208 | VPORT_E_RX_ERROR, | |
f2459fe7 JG |
209 | VPORT_E_TX_DROPPED, |
210 | VPORT_E_TX_ERROR, | |
f2459fe7 JG |
211 | }; |
212 | ||
850b6b3b JG |
213 | struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *, |
214 | const struct vport_parms *); | |
215 | void ovs_vport_free(struct vport *); | |
f2459fe7 JG |
216 | |
217 | #define VPORT_ALIGN 8 | |
218 | ||
219 | /** | |
220 | * vport_priv - access private data area of vport | |
221 | * | |
222 | * @vport: vport to access | |
223 | * | |
224 | * If a nonzero size was passed in priv_size of vport_alloc() a private data | |
225 | * area was allocated on creation. This allows that area to be accessed and | |
226 | * used for any purpose needed by the vport implementer. | |
227 | */ | |
fceb2a5b | 228 | static inline void *vport_priv(const struct vport *vport) |
f2459fe7 JG |
229 | { |
230 | return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN); | |
231 | } | |
232 | ||
233 | /** | |
234 | * vport_from_priv - lookup vport from private data pointer | |
235 | * | |
236 | * @priv: Start of private data area. | |
237 | * | |
238 | * It is sometimes useful to translate from a pointer to the private data | |
239 | * area to the vport, such as in the case where the private data pointer is | |
240 | * the result of a hash table lookup. @priv must point to the start of the | |
241 | * private data area. | |
242 | */ | |
fceb2a5b | 243 | static inline struct vport *vport_from_priv(const void *priv) |
f2459fe7 JG |
244 | { |
245 | return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN)); | |
246 | } | |
247 | ||
850b6b3b JG |
248 | void ovs_vport_receive(struct vport *, struct sk_buff *); |
249 | void ovs_vport_record_error(struct vport *, enum vport_err_type err_type); | |
f2459fe7 | 250 | |
5953c70e JG |
251 | /* List of statically compiled vport implementations. Don't forget to also |
252 | * add yours to the list at the top of vport.c. */ | |
850b6b3b JG |
253 | extern const struct vport_ops ovs_netdev_vport_ops; |
254 | extern const struct vport_ops ovs_internal_vport_ops; | |
255 | extern const struct vport_ops ovs_patch_vport_ops; | |
256 | extern const struct vport_ops ovs_gre_vport_ops; | |
257 | extern const struct vport_ops ovs_capwap_vport_ops; | |
5953c70e | 258 | |
f2459fe7 | 259 | #endif /* vport.h */ |