]>
Commit | Line | Data |
---|---|---|
ccb1352e | 1 | /* |
caf2ee14 | 2 | * Copyright (c) 2007-2012 Nicira, Inc. |
ccb1352e JG |
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 | |
17 | */ | |
18 | ||
19 | #ifndef VPORT_H | |
20 | #define VPORT_H 1 | |
21 | ||
e0f0ecf3 | 22 | #include <linux/if_tunnel.h> |
ccb1352e | 23 | #include <linux/list.h> |
46df7b81 | 24 | #include <linux/netlink.h> |
ccb1352e | 25 | #include <linux/openvswitch.h> |
5cd667b0 | 26 | #include <linux/reciprocal_div.h> |
ccb1352e JG |
27 | #include <linux/skbuff.h> |
28 | #include <linux/spinlock.h> | |
29 | #include <linux/u64_stats_sync.h> | |
30 | ||
31 | #include "datapath.h" | |
32 | ||
33 | struct vport; | |
34 | struct vport_parms; | |
35 | ||
36 | /* The following definitions are for users of the vport subsytem: */ | |
37 | ||
aa310701 PS |
38 | struct vport_net { |
39 | struct vport __rcu *gre_vport; | |
40 | }; | |
41 | ||
ccb1352e JG |
42 | int ovs_vport_init(void); |
43 | void ovs_vport_exit(void); | |
44 | ||
45 | struct vport *ovs_vport_add(const struct vport_parms *); | |
46 | void ovs_vport_del(struct vport *); | |
47 | ||
46df7b81 | 48 | struct vport *ovs_vport_locate(struct net *net, const char *name); |
ccb1352e JG |
49 | |
50 | void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *); | |
51 | ||
52 | int ovs_vport_set_options(struct vport *, struct nlattr *options); | |
53 | int ovs_vport_get_options(const struct vport *, struct sk_buff *); | |
54 | ||
5cd667b0 AW |
55 | int ovs_vport_set_upcall_portids(struct vport *, struct nlattr *pids); |
56 | int ovs_vport_get_upcall_portids(const struct vport *, struct sk_buff *); | |
57 | u32 ovs_vport_find_upcall_portid(const struct vport *, struct sk_buff *); | |
58 | ||
ccb1352e JG |
59 | int ovs_vport_send(struct vport *, struct sk_buff *); |
60 | ||
61 | /* The following definitions are for implementers of vport devices: */ | |
62 | ||
ccb1352e | 63 | struct vport_err_stats { |
e403aded LR |
64 | atomic_long_t rx_dropped; |
65 | atomic_long_t rx_errors; | |
66 | atomic_long_t tx_dropped; | |
67 | atomic_long_t tx_errors; | |
ccb1352e | 68 | }; |
5cd667b0 AW |
69 | /** |
70 | * struct vport_portids - array of netlink portids of a vport. | |
71 | * must be protected by rcu. | |
72 | * @rn_ids: The reciprocal value of @n_ids. | |
73 | * @rcu: RCU callback head for deferred destruction. | |
74 | * @n_ids: Size of @ids array. | |
75 | * @ids: Array storing the Netlink socket pids to be used for packets received | |
76 | * on this port that miss the flow table. | |
77 | */ | |
78 | struct vport_portids { | |
79 | struct reciprocal_value rn_ids; | |
80 | struct rcu_head rcu; | |
81 | u32 n_ids; | |
82 | u32 ids[]; | |
83 | }; | |
ccb1352e JG |
84 | |
85 | /** | |
86 | * struct vport - one port within a datapath | |
87 | * @rcu: RCU callback head for deferred destruction. | |
ccb1352e | 88 | * @dp: Datapath to which this port belongs. |
5cd667b0 | 89 | * @upcall_portids: RCU protected 'struct vport_portids'. |
03599c94 | 90 | * @port_no: Index into @dp's @ports array. |
ccb1352e | 91 | * @hash_node: Element in @dev_table hash table in vport.c. |
15eac2a7 | 92 | * @dp_hash_node: Element in @datapath->ports hash table in datapath.c. |
ccb1352e JG |
93 | * @ops: Class structure. |
94 | * @percpu_stats: Points to per-CPU statistics used and maintained by vport | |
ccb1352e JG |
95 | * @err_stats: Points to error statistics used and maintained by vport |
96 | */ | |
97 | struct vport { | |
98 | struct rcu_head rcu; | |
ccb1352e | 99 | struct datapath *dp; |
5cd667b0 | 100 | struct vport_portids __rcu *upcall_portids; |
03599c94 | 101 | u16 port_no; |
ccb1352e JG |
102 | |
103 | struct hlist_node hash_node; | |
15eac2a7 | 104 | struct hlist_node dp_hash_node; |
ccb1352e JG |
105 | const struct vport_ops *ops; |
106 | ||
8f84985f | 107 | struct pcpu_sw_netstats __percpu *percpu_stats; |
ccb1352e | 108 | |
ccb1352e JG |
109 | struct vport_err_stats err_stats; |
110 | }; | |
111 | ||
112 | /** | |
113 | * struct vport_parms - parameters for creating a new vport | |
114 | * | |
115 | * @name: New vport's name. | |
116 | * @type: New vport's type. | |
117 | * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if | |
118 | * none was supplied. | |
119 | * @dp: New vport's datapath. | |
120 | * @port_no: New vport's port number. | |
121 | */ | |
122 | struct vport_parms { | |
123 | const char *name; | |
124 | enum ovs_vport_type type; | |
125 | struct nlattr *options; | |
126 | ||
127 | /* For ovs_vport_alloc(). */ | |
128 | struct datapath *dp; | |
129 | u16 port_no; | |
5cd667b0 | 130 | struct nlattr *upcall_portids; |
ccb1352e JG |
131 | }; |
132 | ||
133 | /** | |
134 | * struct vport_ops - definition of a type of virtual port | |
135 | * | |
136 | * @type: %OVS_VPORT_TYPE_* value for this type of virtual port. | |
137 | * @create: Create a new vport configured as specified. On success returns | |
138 | * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value. | |
139 | * @destroy: Destroys a vport. Must call vport_free() on the vport but not | |
140 | * before an RCU grace period has elapsed. | |
141 | * @set_options: Modify the configuration of an existing vport. May be %NULL | |
142 | * if modification is not supported. | |
143 | * @get_options: Appends vport-specific attributes for the configuration of an | |
144 | * existing vport to a &struct sk_buff. May be %NULL for a vport that does not | |
145 | * have any configuration. | |
146 | * @get_name: Get the device's name. | |
91b7514c PS |
147 | * @send: Send a packet on the device. Returns the length of the packet sent, |
148 | * zero for dropped packets or negative for error. | |
ccb1352e JG |
149 | */ |
150 | struct vport_ops { | |
151 | enum ovs_vport_type type; | |
152 | ||
8e4e1713 | 153 | /* Called with ovs_mutex. */ |
ccb1352e JG |
154 | struct vport *(*create)(const struct vport_parms *); |
155 | void (*destroy)(struct vport *); | |
156 | ||
157 | int (*set_options)(struct vport *, struct nlattr *); | |
158 | int (*get_options)(const struct vport *, struct sk_buff *); | |
159 | ||
8e4e1713 | 160 | /* Called with rcu_read_lock or ovs_mutex. */ |
ccb1352e | 161 | const char *(*get_name)(const struct vport *); |
ccb1352e JG |
162 | |
163 | int (*send)(struct vport *, struct sk_buff *); | |
164 | }; | |
165 | ||
166 | enum vport_err_type { | |
167 | VPORT_E_RX_DROPPED, | |
168 | VPORT_E_RX_ERROR, | |
169 | VPORT_E_TX_DROPPED, | |
170 | VPORT_E_TX_ERROR, | |
171 | }; | |
172 | ||
173 | struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *, | |
174 | const struct vport_parms *); | |
175 | void ovs_vport_free(struct vport *); | |
aa310701 | 176 | void ovs_vport_deferred_free(struct vport *vport); |
ccb1352e JG |
177 | |
178 | #define VPORT_ALIGN 8 | |
179 | ||
180 | /** | |
181 | * vport_priv - access private data area of vport | |
182 | * | |
183 | * @vport: vport to access | |
184 | * | |
185 | * If a nonzero size was passed in priv_size of vport_alloc() a private data | |
186 | * area was allocated on creation. This allows that area to be accessed and | |
187 | * used for any purpose needed by the vport implementer. | |
188 | */ | |
189 | static inline void *vport_priv(const struct vport *vport) | |
190 | { | |
07dc0602 | 191 | return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN); |
ccb1352e JG |
192 | } |
193 | ||
194 | /** | |
195 | * vport_from_priv - lookup vport from private data pointer | |
196 | * | |
197 | * @priv: Start of private data area. | |
198 | * | |
199 | * It is sometimes useful to translate from a pointer to the private data | |
200 | * area to the vport, such as in the case where the private data pointer is | |
201 | * the result of a hash table lookup. @priv must point to the start of the | |
202 | * private data area. | |
203 | */ | |
d0b4da13 | 204 | static inline struct vport *vport_from_priv(void *priv) |
ccb1352e | 205 | { |
d0b4da13 | 206 | return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN)); |
ccb1352e JG |
207 | } |
208 | ||
7d5437c7 | 209 | void ovs_vport_receive(struct vport *, struct sk_buff *, |
f0b128c1 | 210 | struct ovs_tunnel_info *); |
ccb1352e JG |
211 | |
212 | /* List of statically compiled vport implementations. Don't forget to also | |
213 | * add yours to the list at the top of vport.c. */ | |
214 | extern const struct vport_ops ovs_netdev_vport_ops; | |
215 | extern const struct vport_ops ovs_internal_vport_ops; | |
aa310701 | 216 | extern const struct vport_ops ovs_gre_vport_ops; |
58264848 | 217 | extern const struct vport_ops ovs_vxlan_vport_ops; |
f5796684 | 218 | extern const struct vport_ops ovs_geneve_vport_ops; |
ccb1352e | 219 | |
b34df5e8 PS |
220 | static inline void ovs_skb_postpush_rcsum(struct sk_buff *skb, |
221 | const void *start, unsigned int len) | |
222 | { | |
223 | if (skb->ip_summed == CHECKSUM_COMPLETE) | |
224 | skb->csum = csum_add(skb->csum, csum_partial(start, len, 0)); | |
225 | } | |
226 | ||
ccb1352e | 227 | #endif /* vport.h */ |