]>
Commit | Line | Data |
---|---|---|
f2459fe7 | 1 | /* |
e23775f2 | 2 | * Copyright (c) 2007-2015 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 | ||
a0049ffc | 22 | #include <linux/if_tunnel.h> |
f2459fe7 | 23 | #include <linux/list.h> |
2a4999f3 | 24 | #include <linux/netlink.h> |
077257b8 | 25 | #include <linux/openvswitch.h> |
beb1c69a | 26 | #include <linux/reciprocal_div.h> |
f2459fe7 JG |
27 | #include <linux/skbuff.h> |
28 | #include <linux/spinlock.h> | |
821cb9fa | 29 | #include <linux/u64_stats_sync.h> |
e23775f2 PS |
30 | |
31 | #include "datapath.h" | |
f2459fe7 | 32 | |
f2459fe7 | 33 | struct vport; |
94903c98 | 34 | struct vport_parms; |
f2459fe7 JG |
35 | |
36 | /* The following definitions are for users of the vport subsytem: */ | |
37 | ||
850b6b3b JG |
38 | int ovs_vport_init(void); |
39 | void ovs_vport_exit(void); | |
f2459fe7 | 40 | |
850b6b3b JG |
41 | struct vport *ovs_vport_add(const struct vport_parms *); |
42 | void ovs_vport_del(struct vport *); | |
f2459fe7 | 43 | |
f1f60b85 | 44 | struct vport *ovs_vport_locate(const struct net *net, const char *name); |
f2459fe7 | 45 | |
850b6b3b | 46 | void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *); |
f2459fe7 | 47 | |
850b6b3b JG |
48 | int ovs_vport_set_options(struct vport *, struct nlattr *options); |
49 | int ovs_vport_get_options(const struct vport *, struct sk_buff *); | |
f2459fe7 | 50 | |
f1f60b85 | 51 | int ovs_vport_set_upcall_portids(struct vport *, const struct nlattr *pids); |
beb1c69a AW |
52 | int ovs_vport_get_upcall_portids(const struct vport *, struct sk_buff *); |
53 | u32 ovs_vport_find_upcall_portid(const struct vport *, struct sk_buff *); | |
54 | ||
beb1c69a AW |
55 | /** |
56 | * struct vport_portids - array of netlink portids of a vport. | |
57 | * must be protected by rcu. | |
58 | * @rn_ids: The reciprocal value of @n_ids. | |
59 | * @rcu: RCU callback head for deferred destruction. | |
60 | * @n_ids: Size of @ids array. | |
61 | * @ids: Array storing the Netlink socket pids to be used for packets received | |
62 | * on this port that miss the flow table. | |
63 | */ | |
64 | struct vport_portids { | |
65 | struct reciprocal_value rn_ids; | |
66 | struct rcu_head rcu; | |
67 | u32 n_ids; | |
68 | u32 ids[]; | |
69 | }; | |
f2459fe7 | 70 | |
e779d8d9 BP |
71 | /** |
72 | * struct vport - one port within a datapath | |
8063e095 | 73 | * @dev: Pointer to net_device. |
e779d8d9 | 74 | * @dp: Datapath to which this port belongs. |
beb1c69a | 75 | * @upcall_portids: RCU protected 'struct vport_portids'. |
3da83627 | 76 | * @port_no: Index into @dp's @ports array. |
e779d8d9 | 77 | * @hash_node: Element in @dev_table hash table in vport.c. |
95b1d73a | 78 | * @dp_hash_node: Element in @datapath->ports hash table in datapath.c. |
e779d8d9 | 79 | * @ops: Class structure. |
cabd5516 | 80 | * @detach_list: list used for detaching vport in net-exit call. |
8063e095 | 81 | * @rcu: RCU callback head for deferred destruction. |
e779d8d9 | 82 | */ |
f2459fe7 | 83 | struct vport { |
e23775f2 | 84 | struct net_device *dev; |
e779d8d9 | 85 | struct datapath *dp; |
beb1c69a | 86 | struct vport_portids __rcu *upcall_portids; |
3da83627 | 87 | u16 port_no; |
e779d8d9 | 88 | |
f2459fe7 | 89 | struct hlist_node hash_node; |
95b1d73a | 90 | struct hlist_node dp_hash_node; |
f2459fe7 | 91 | const struct vport_ops *ops; |
f2459fe7 | 92 | |
cabd5516 | 93 | struct list_head detach_list; |
e23775f2 | 94 | struct rcu_head rcu; |
f2459fe7 JG |
95 | }; |
96 | ||
94903c98 BP |
97 | /** |
98 | * struct vport_parms - parameters for creating a new vport | |
99 | * | |
100 | * @name: New vport's name. | |
101 | * @type: New vport's type. | |
df2c07f4 | 102 | * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if |
c19e6535 | 103 | * none was supplied. |
e779d8d9 BP |
104 | * @dp: New vport's datapath. |
105 | * @port_no: New vport's port number. | |
94903c98 BP |
106 | */ |
107 | struct vport_parms { | |
108 | const char *name; | |
df2c07f4 | 109 | enum ovs_vport_type type; |
c19e6535 | 110 | struct nlattr *options; |
e779d8d9 | 111 | |
850b6b3b | 112 | /* For ovs_vport_alloc(). */ |
e779d8d9 BP |
113 | struct datapath *dp; |
114 | u16 port_no; | |
beb1c69a | 115 | struct nlattr *upcall_portids; |
94903c98 BP |
116 | }; |
117 | ||
f2459fe7 JG |
118 | /** |
119 | * struct vport_ops - definition of a type of virtual port | |
120 | * | |
df2c07f4 | 121 | * @type: %OVS_VPORT_TYPE_* value for this type of virtual port. |
94903c98 | 122 | * @create: Create a new vport configured as specified. On success returns |
850b6b3b | 123 | * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value. |
057dd6d2 BP |
124 | * @destroy: Destroys a vport. Must call vport_free() on the vport but not |
125 | * before an RCU grace period has elapsed. | |
c19e6535 BP |
126 | * @set_options: Modify the configuration of an existing vport. May be %NULL |
127 | * if modification is not supported. | |
128 | * @get_options: Appends vport-specific attributes for the configuration of an | |
129 | * existing vport to a &struct sk_buff. May be %NULL for a vport that does not | |
130 | * have any configuration. | |
e23775f2 | 131 | * @send: Send a packet on the device. |
be7cd27e | 132 | * zero for dropped packets or negative for error. |
f2459fe7 JG |
133 | */ |
134 | struct vport_ops { | |
df2c07f4 | 135 | enum ovs_vport_type type; |
f2459fe7 | 136 | |
cd2a59e9 | 137 | /* Called with ovs_mutex. */ |
94903c98 | 138 | struct vport *(*create)(const struct vport_parms *); |
3544358a | 139 | void (*destroy)(struct vport *); |
f2459fe7 | 140 | |
c19e6535 BP |
141 | int (*set_options)(struct vport *, struct nlattr *); |
142 | int (*get_options)(const struct vport *, struct sk_buff *); | |
143 | ||
8063e095 | 144 | netdev_tx_t (*send)(struct sk_buff *skb); |
aad7cb91 | 145 | int (*fill_metadata_dst)(struct net_device *dev, struct sk_buff *skb); |
5a38795f TG |
146 | |
147 | struct module *owner; | |
148 | struct list_head list; | |
f2459fe7 JG |
149 | }; |
150 | ||
850b6b3b JG |
151 | struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *, |
152 | const struct vport_parms *); | |
153 | void ovs_vport_free(struct vport *); | |
c405d282 | 154 | void ovs_vport_deferred_free(struct vport *vport); |
f2459fe7 JG |
155 | |
156 | #define VPORT_ALIGN 8 | |
157 | ||
158 | /** | |
159 | * vport_priv - access private data area of vport | |
160 | * | |
161 | * @vport: vport to access | |
162 | * | |
163 | * If a nonzero size was passed in priv_size of vport_alloc() a private data | |
164 | * area was allocated on creation. This allows that area to be accessed and | |
165 | * used for any purpose needed by the vport implementer. | |
166 | */ | |
fceb2a5b | 167 | static inline void *vport_priv(const struct vport *vport) |
f2459fe7 | 168 | { |
61df3421 | 169 | return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN); |
f2459fe7 JG |
170 | } |
171 | ||
172 | /** | |
173 | * vport_from_priv - lookup vport from private data pointer | |
174 | * | |
175 | * @priv: Start of private data area. | |
176 | * | |
177 | * It is sometimes useful to translate from a pointer to the private data | |
178 | * area to the vport, such as in the case where the private data pointer is | |
179 | * the result of a hash table lookup. @priv must point to the start of the | |
180 | * private data area. | |
181 | */ | |
38b5f1e7 | 182 | static inline struct vport *vport_from_priv(void *priv) |
f2459fe7 | 183 | { |
38b5f1e7 | 184 | return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN)); |
f2459fe7 JG |
185 | } |
186 | ||
e23775f2 PS |
187 | int ovs_vport_receive(struct vport *, struct sk_buff *, |
188 | const struct ip_tunnel_info *); | |
f2459fe7 | 189 | |
e23775f2 PS |
190 | static inline const char *ovs_vport_name(struct vport *vport) |
191 | { | |
192 | return vport->dev->name; | |
193 | } | |
194 | ||
f07995ef PS |
195 | int __ovs_vport_ops_register(struct vport_ops *ops); |
196 | #define ovs_vport_ops_register(ops) \ | |
8063e095 PS |
197 | ({ \ |
198 | (ops)->owner = THIS_MODULE; \ | |
199 | __ovs_vport_ops_register(ops); \ | |
200 | }) | |
f07995ef | 201 | |
5a38795f | 202 | void ovs_vport_ops_unregister(struct vport_ops *ops); |
e23775f2 | 203 | void ovs_vport_send(struct vport *vport, struct sk_buff *skb); |
8063e095 | 204 | |
f2459fe7 | 205 | #endif /* vport.h */ |