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 JG |
25 | #include <linux/openvswitch.h> |
26 | #include <linux/skbuff.h> | |
27 | #include <linux/spinlock.h> | |
28 | #include <linux/u64_stats_sync.h> | |
29 | ||
30 | #include "datapath.h" | |
31 | ||
32 | struct vport; | |
33 | struct vport_parms; | |
34 | ||
35 | /* The following definitions are for users of the vport subsytem: */ | |
36 | ||
aa310701 PS |
37 | /* The following definitions are for users of the vport subsytem: */ |
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 | ||
55 | int ovs_vport_send(struct vport *, struct sk_buff *); | |
56 | ||
57 | /* The following definitions are for implementers of vport devices: */ | |
58 | ||
ccb1352e JG |
59 | struct vport_err_stats { |
60 | u64 rx_dropped; | |
61 | u64 rx_errors; | |
62 | u64 tx_dropped; | |
63 | u64 tx_errors; | |
64 | }; | |
65 | ||
66 | /** | |
67 | * struct vport - one port within a datapath | |
68 | * @rcu: RCU callback head for deferred destruction. | |
ccb1352e | 69 | * @dp: Datapath to which this port belongs. |
15e47304 | 70 | * @upcall_portid: The Netlink port to use for packets received on this port that |
ccb1352e | 71 | * miss the flow table. |
03599c94 | 72 | * @port_no: Index into @dp's @ports array. |
ccb1352e | 73 | * @hash_node: Element in @dev_table hash table in vport.c. |
15eac2a7 | 74 | * @dp_hash_node: Element in @datapath->ports hash table in datapath.c. |
ccb1352e JG |
75 | * @ops: Class structure. |
76 | * @percpu_stats: Points to per-CPU statistics used and maintained by vport | |
77 | * @stats_lock: Protects @err_stats; | |
78 | * @err_stats: Points to error statistics used and maintained by vport | |
79 | */ | |
80 | struct vport { | |
81 | struct rcu_head rcu; | |
ccb1352e | 82 | struct datapath *dp; |
15e47304 | 83 | u32 upcall_portid; |
03599c94 | 84 | u16 port_no; |
ccb1352e JG |
85 | |
86 | struct hlist_node hash_node; | |
15eac2a7 | 87 | struct hlist_node dp_hash_node; |
ccb1352e JG |
88 | const struct vport_ops *ops; |
89 | ||
e0f0ecf3 | 90 | struct pcpu_tstats __percpu *percpu_stats; |
ccb1352e JG |
91 | |
92 | spinlock_t stats_lock; | |
93 | struct vport_err_stats err_stats; | |
94 | }; | |
95 | ||
96 | /** | |
97 | * struct vport_parms - parameters for creating a new vport | |
98 | * | |
99 | * @name: New vport's name. | |
100 | * @type: New vport's type. | |
101 | * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if | |
102 | * none was supplied. | |
103 | * @dp: New vport's datapath. | |
104 | * @port_no: New vport's port number. | |
105 | */ | |
106 | struct vport_parms { | |
107 | const char *name; | |
108 | enum ovs_vport_type type; | |
109 | struct nlattr *options; | |
110 | ||
111 | /* For ovs_vport_alloc(). */ | |
112 | struct datapath *dp; | |
113 | u16 port_no; | |
15e47304 | 114 | u32 upcall_portid; |
ccb1352e JG |
115 | }; |
116 | ||
117 | /** | |
118 | * struct vport_ops - definition of a type of virtual port | |
119 | * | |
120 | * @type: %OVS_VPORT_TYPE_* value for this type of virtual port. | |
121 | * @create: Create a new vport configured as specified. On success returns | |
122 | * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value. | |
123 | * @destroy: Destroys a vport. Must call vport_free() on the vport but not | |
124 | * before an RCU grace period has elapsed. | |
125 | * @set_options: Modify the configuration of an existing vport. May be %NULL | |
126 | * if modification is not supported. | |
127 | * @get_options: Appends vport-specific attributes for the configuration of an | |
128 | * existing vport to a &struct sk_buff. May be %NULL for a vport that does not | |
129 | * have any configuration. | |
130 | * @get_name: Get the device's name. | |
91b7514c PS |
131 | * @send: Send a packet on the device. Returns the length of the packet sent, |
132 | * zero for dropped packets or negative for error. | |
ccb1352e JG |
133 | */ |
134 | struct vport_ops { | |
135 | enum ovs_vport_type type; | |
136 | ||
8e4e1713 | 137 | /* Called with ovs_mutex. */ |
ccb1352e JG |
138 | struct vport *(*create)(const struct vport_parms *); |
139 | void (*destroy)(struct vport *); | |
140 | ||
141 | int (*set_options)(struct vport *, struct nlattr *); | |
142 | int (*get_options)(const struct vport *, struct sk_buff *); | |
143 | ||
8e4e1713 | 144 | /* Called with rcu_read_lock or ovs_mutex. */ |
ccb1352e | 145 | const char *(*get_name)(const struct vport *); |
ccb1352e JG |
146 | |
147 | int (*send)(struct vport *, struct sk_buff *); | |
148 | }; | |
149 | ||
150 | enum vport_err_type { | |
151 | VPORT_E_RX_DROPPED, | |
152 | VPORT_E_RX_ERROR, | |
153 | VPORT_E_TX_DROPPED, | |
154 | VPORT_E_TX_ERROR, | |
155 | }; | |
156 | ||
157 | struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *, | |
158 | const struct vport_parms *); | |
159 | void ovs_vport_free(struct vport *); | |
aa310701 | 160 | void ovs_vport_deferred_free(struct vport *vport); |
ccb1352e JG |
161 | |
162 | #define VPORT_ALIGN 8 | |
163 | ||
164 | /** | |
165 | * vport_priv - access private data area of vport | |
166 | * | |
167 | * @vport: vport to access | |
168 | * | |
169 | * If a nonzero size was passed in priv_size of vport_alloc() a private data | |
170 | * area was allocated on creation. This allows that area to be accessed and | |
171 | * used for any purpose needed by the vport implementer. | |
172 | */ | |
173 | static inline void *vport_priv(const struct vport *vport) | |
174 | { | |
175 | return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN); | |
176 | } | |
177 | ||
178 | /** | |
179 | * vport_from_priv - lookup vport from private data pointer | |
180 | * | |
181 | * @priv: Start of private data area. | |
182 | * | |
183 | * It is sometimes useful to translate from a pointer to the private data | |
184 | * area to the vport, such as in the case where the private data pointer is | |
185 | * the result of a hash table lookup. @priv must point to the start of the | |
186 | * private data area. | |
187 | */ | |
188 | static inline struct vport *vport_from_priv(const void *priv) | |
189 | { | |
190 | return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN)); | |
191 | } | |
192 | ||
7d5437c7 PS |
193 | void ovs_vport_receive(struct vport *, struct sk_buff *, |
194 | struct ovs_key_ipv4_tunnel *); | |
ccb1352e JG |
195 | void ovs_vport_record_error(struct vport *, enum vport_err_type err_type); |
196 | ||
197 | /* List of statically compiled vport implementations. Don't forget to also | |
198 | * add yours to the list at the top of vport.c. */ | |
199 | extern const struct vport_ops ovs_netdev_vport_ops; | |
200 | extern const struct vport_ops ovs_internal_vport_ops; | |
aa310701 | 201 | extern const struct vport_ops ovs_gre_vport_ops; |
ccb1352e | 202 | |
b34df5e8 PS |
203 | static inline void ovs_skb_postpush_rcsum(struct sk_buff *skb, |
204 | const void *start, unsigned int len) | |
205 | { | |
206 | if (skb->ip_summed == CHECKSUM_COMPLETE) | |
207 | skb->csum = csum_add(skb->csum, csum_partial(start, len, 0)); | |
208 | } | |
209 | ||
ccb1352e | 210 | #endif /* vport.h */ |