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