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