Add IPv6 support for OpenFlow, OVSDB, NetFlow, and sFlow.
[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/if_tunnel.h>
23 #include <linux/list.h>
24 #include <linux/netlink.h>
25 #include <linux/openvswitch.h>
26 #include <linux/skbuff.h>
27 #include <linux/spinlock.h>
28 #include <linux/u64_stats_sync.h>
29
30 struct vport;
31 struct vport_parms;
32
33 /* The following definitions are for users of the vport subsytem: */
34 struct vport_net {
35         struct vport __rcu *gre_vport;
36         struct vport __rcu *gre64_vport;
37 };
38
39 int ovs_vport_init(void);
40 void ovs_vport_exit(void);
41
42 struct vport *ovs_vport_add(const struct vport_parms *);
43 void ovs_vport_del(struct vport *);
44
45 struct vport *ovs_vport_locate(struct net *net, const char *name);
46
47 void ovs_vport_set_stats(struct vport *, struct ovs_vport_stats *);
48 void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *);
49
50 int ovs_vport_set_options(struct vport *, struct nlattr *options);
51 int ovs_vport_get_options(const struct vport *, struct sk_buff *);
52
53 int ovs_vport_send(struct vport *, struct sk_buff *);
54
55 /* The following definitions are for implementers of vport devices: */
56
57 struct vport_err_stats {
58         u64 rx_dropped;
59         u64 rx_errors;
60         u64 tx_dropped;
61         u64 tx_errors;
62 };
63
64 /**
65  * struct vport - one port within a datapath
66  * @rcu: RCU callback head for deferred destruction.
67  * @dp: Datapath to which this port belongs.
68  * @upcall_portid: The Netlink port to use for packets received on this port that
69  * miss the flow table.
70  * @port_no: Index into @dp's @ports array.
71  * @hash_node: Element in @dev_table hash table in vport.c.
72  * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
73  * @ops: Class structure.
74  * @percpu_stats: Points to per-CPU statistics used and maintained by vport
75  * @stats_lock: Protects @err_stats and @offset_stats.
76  * @err_stats: Points to error statistics used and maintained by vport
77  * @offset_stats: Added to actual statistics as a sop to compatibility with
78  * XAPI for Citrix XenServer.  Deprecated.
79  */
80 struct vport {
81         struct rcu_head rcu;
82         struct datapath *dp;
83         u32 upcall_portid;
84         u16 port_no;
85
86         struct hlist_node hash_node;
87         struct hlist_node dp_hash_node;
88         const struct vport_ops *ops;
89
90         struct pcpu_tstats __percpu *percpu_stats;
91
92         spinlock_t stats_lock;
93         struct vport_err_stats err_stats;
94         struct ovs_vport_stats offset_stats;
95 };
96
97 /**
98  * struct vport_parms - parameters for creating a new vport
99  *
100  * @name: New vport's name.
101  * @type: New vport's type.
102  * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
103  * none was supplied.
104  * @dp: New vport's datapath.
105  * @port_no: New vport's port number.
106  */
107 struct vport_parms {
108         const char *name;
109         enum ovs_vport_type type;
110         struct nlattr *options;
111
112         /* For ovs_vport_alloc(). */
113         struct datapath *dp;
114         u16 port_no;
115         u32 upcall_portid;
116 };
117
118 /**
119  * struct vport_ops - definition of a type of virtual port
120  *
121  * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
122  * @create: Create a new vport configured as specified.  On success returns
123  * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
124  * @destroy: Destroys a vport.  Must call vport_free() on the vport but not
125  * before an RCU grace period has elapsed.
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.
131  * @get_name: Get the device's name.
132  * @send: Send a packet on the device.  Returns the length of the packet sent,
133  * zero for dropped packets or negative for error.
134  */
135 struct vport_ops {
136         enum ovs_vport_type type;
137
138         /* Called with ovs_mutex. */
139         struct vport *(*create)(const struct vport_parms *);
140         void (*destroy)(struct vport *);
141
142         int (*set_options)(struct vport *, struct nlattr *);
143         int (*get_options)(const struct vport *, struct sk_buff *);
144
145         /* Called with rcu_read_lock or ovs_mutex. */
146         const char *(*get_name)(const struct vport *);
147
148         int (*send)(struct vport *, struct sk_buff *);
149 };
150
151 enum vport_err_type {
152         VPORT_E_RX_DROPPED,
153         VPORT_E_RX_ERROR,
154         VPORT_E_TX_DROPPED,
155         VPORT_E_TX_ERROR,
156 };
157
158 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
159                               const struct vport_parms *);
160 void ovs_vport_free(struct vport *);
161 void ovs_vport_deferred_free(struct vport *vport);
162
163 #define VPORT_ALIGN 8
164
165 /**
166  *      vport_priv - access private data area of vport
167  *
168  * @vport: vport to access
169  *
170  * If a nonzero size was passed in priv_size of vport_alloc() a private data
171  * area was allocated on creation.  This allows that area to be accessed and
172  * used for any purpose needed by the vport implementer.
173  */
174 static inline void *vport_priv(const struct vport *vport)
175 {
176         return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
177 }
178
179 /**
180  *      vport_from_priv - lookup vport from private data pointer
181  *
182  * @priv: Start of private data area.
183  *
184  * It is sometimes useful to translate from a pointer to the private data
185  * area to the vport, such as in the case where the private data pointer is
186  * the result of a hash table lookup.  @priv must point to the start of the
187  * private data area.
188  */
189 static inline struct vport *vport_from_priv(void *priv)
190 {
191         return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
192 }
193
194 void ovs_vport_receive(struct vport *, struct sk_buff *,
195                        struct ovs_key_ipv4_tunnel *);
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;
201 extern const struct vport_ops ovs_gre_vport_ops;
202 extern const struct vport_ops ovs_gre64_vport_ops;
203 extern const struct vport_ops ovs_vxlan_vport_ops;
204 extern const struct vport_ops ovs_lisp_vport_ops;
205
206 static inline void ovs_skb_postpush_rcsum(struct sk_buff *skb,
207                                       const void *start, unsigned int len)
208 {
209         if (skb->ip_summed == CHECKSUM_COMPLETE)
210                 skb->csum = csum_add(skb->csum, csum_partial(start, len, 0));
211 }
212 #endif /* vport.h */