datapath: Factor out common code from *_build_header() to ovs_tnl_send().
[sliver-openvswitch.git] / datapath / vport.h
1 /*
2  * Copyright (c) 2007-2012 Nicira, Inc.
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
22 #include <linux/list.h>
23 #include <linux/netlink.h>
24 #include <linux/openvswitch.h>
25 #include <linux/skbuff.h>
26 #include <linux/spinlock.h>
27 #include <linux/u64_stats_sync.h>
28
29 struct vport;
30 struct vport_parms;
31
32 /* The following definitions are for users of the vport subsytem: */
33 struct vport_net {
34         struct vport __rcu *gre_vport;
35         struct vport __rcu *gre64_vport;
36 };
37
38 int ovs_vport_init(void);
39 void ovs_vport_exit(void);
40
41 struct vport *ovs_vport_add(const struct vport_parms *);
42 void ovs_vport_del(struct vport *);
43
44 struct vport *ovs_vport_locate(struct net *net, const char *name);
45
46 void ovs_vport_set_stats(struct vport *, struct ovs_vport_stats *);
47 void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *);
48
49 int ovs_vport_set_options(struct vport *, struct nlattr *options);
50 int ovs_vport_get_options(const struct vport *, struct sk_buff *);
51
52 int ovs_vport_send(struct vport *, struct sk_buff *);
53
54 /* The following definitions are for implementers of vport devices: */
55
56 struct vport_percpu_stats {
57         u64 rx_bytes;
58         u64 rx_packets;
59         u64 tx_bytes;
60         u64 tx_packets;
61         struct u64_stats_sync sync;
62 };
63
64 struct vport_err_stats {
65         u64 rx_dropped;
66         u64 rx_errors;
67         u64 tx_dropped;
68         u64 tx_errors;
69 };
70
71 /**
72  * struct vport - one port within a datapath
73  * @rcu: RCU callback head for deferred destruction.
74  * @dp: Datapath to which this port belongs.
75  * @linkname: The name of the link from /sys/class/net/<datapath>/brif to this
76  * &struct vport.  (We keep this around so that we can delete it if the
77  * device gets renamed.)  Set to the null string when no link exists.
78  * @upcall_portid: The Netlink port to use for packets received on this port that
79  * miss the flow table.
80  * @port_no: Index into @dp's @ports array.
81  * @hash_node: Element in @dev_table hash table in vport.c.
82  * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
83  * @ops: Class structure.
84  * @percpu_stats: Points to per-CPU statistics used and maintained by vport
85  * @stats_lock: Protects @err_stats and @offset_stats.
86  * @err_stats: Points to error statistics used and maintained by vport
87  * @offset_stats: Added to actual statistics as a sop to compatibility with
88  * XAPI for Citrix XenServer.  Deprecated.
89  */
90 struct vport {
91         struct rcu_head rcu;
92         struct datapath *dp;
93         char linkname[IFNAMSIZ];
94         u32 upcall_portid;
95         u16 port_no;
96
97         struct hlist_node hash_node;
98         struct hlist_node dp_hash_node;
99         const struct vport_ops *ops;
100
101         struct vport_percpu_stats __percpu *percpu_stats;
102
103         spinlock_t stats_lock;
104         struct vport_err_stats err_stats;
105         struct ovs_vport_stats offset_stats;
106 };
107
108 #define VPORT_F_REQUIRED        (1 << 0) /* If init fails, module loading fails. */
109 #define VPORT_F_TUN_ID          (1 << 1) /* Sets OVS_CB(skb)->tun_id. */
110
111 /**
112  * struct vport_parms - parameters for creating a new vport
113  *
114  * @name: New vport's name.
115  * @type: New vport's type.
116  * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
117  * none was supplied.
118  * @dp: New vport's datapath.
119  * @port_no: New vport's port number.
120  */
121 struct vport_parms {
122         const char *name;
123         enum ovs_vport_type type;
124         struct nlattr *options;
125
126         /* For ovs_vport_alloc(). */
127         struct datapath *dp;
128         u16 port_no;
129         u32 upcall_portid;
130 };
131
132 /**
133  * struct vport_ops - definition of a type of virtual port
134  *
135  * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
136  * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
137  * handles this vport.
138  * @init: Called at module initialization.  If VPORT_F_REQUIRED is set then the
139  * failure of this function will cause the module to not load.  If the flag is
140  * not set and initialzation fails then no vports of this type can be created.
141  * @exit: Called at module unload.
142  * @create: Create a new vport configured as specified.  On success returns
143  * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
144  * @destroy: Destroys a vport.  Must call vport_free() on the vport but not
145  * before an RCU grace period has elapsed.
146  * @set_options: Modify the configuration of an existing vport.  May be %NULL
147  * if modification is not supported.
148  * @get_options: Appends vport-specific attributes for the configuration of an
149  * existing vport to a &struct sk_buff.  May be %NULL for a vport that does not
150  * have any configuration.
151  * @get_name: Get the device's name.
152  * @get_config: Get the device's configuration.
153  * @get_ifindex: Get the system interface index associated with the device.
154  * May be null if the device does not have an ifindex.
155  * @send: Send a packet on the device.  Returns the length of the packet sent.
156  */
157 struct vport_ops {
158         enum ovs_vport_type type;
159         u32 flags;
160
161         /* Called at module init and exit respectively. */
162         int (*init)(void);
163         void (*exit)(void);
164
165         /* Called with RTNL lock. */
166         struct vport *(*create)(const struct vport_parms *);
167         void (*destroy)(struct vport *);
168
169         int (*set_options)(struct vport *, struct nlattr *);
170         int (*get_options)(const struct vport *, struct sk_buff *);
171
172         /* Called with rcu_read_lock or RTNL lock. */
173         const char *(*get_name)(const struct vport *);
174         void (*get_config)(const struct vport *, void *);
175         int (*get_ifindex)(const struct vport *);
176         int (*send)(struct vport *, struct sk_buff *);
177 };
178
179 enum vport_err_type {
180         VPORT_E_RX_DROPPED,
181         VPORT_E_RX_ERROR,
182         VPORT_E_TX_DROPPED,
183         VPORT_E_TX_ERROR,
184 };
185
186 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
187                               const struct vport_parms *);
188 void ovs_vport_free(struct vport *);
189
190 #define VPORT_ALIGN 8
191
192 /**
193  *      vport_priv - access private data area of vport
194  *
195  * @vport: vport to access
196  *
197  * If a nonzero size was passed in priv_size of vport_alloc() a private data
198  * area was allocated on creation.  This allows that area to be accessed and
199  * used for any purpose needed by the vport implementer.
200  */
201 static inline void *vport_priv(const struct vport *vport)
202 {
203         return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
204 }
205
206 /**
207  *      vport_from_priv - lookup vport from private data pointer
208  *
209  * @priv: Start of private data area.
210  *
211  * It is sometimes useful to translate from a pointer to the private data
212  * area to the vport, such as in the case where the private data pointer is
213  * the result of a hash table lookup.  @priv must point to the start of the
214  * private data area.
215  */
216 static inline struct vport *vport_from_priv(const void *priv)
217 {
218         return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
219 }
220
221 void ovs_vport_receive(struct vport *, struct sk_buff *);
222 void ovs_vport_record_error(struct vport *, enum vport_err_type err_type);
223
224 /* List of statically compiled vport implementations.  Don't forget to also
225  * add yours to the list at the top of vport.c. */
226 extern const struct vport_ops ovs_netdev_vport_ops;
227 extern const struct vport_ops ovs_internal_vport_ops;
228 extern const struct vport_ops ovs_gre_vport_ops;
229 extern const struct vport_ops ovs_gre64_vport_ops;
230 extern const struct vport_ops ovs_vxlan_vport_ops;
231 extern const struct vport_ops ovs_lisp_vport_ops;
232
233 #endif /* vport.h */