]>
git.proxmox.com Git - mirror_ovs.git/blob - datapath/vport.h
2 * Copyright (c) 2007-2015 Nicira, Inc.
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.
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.
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
22 #include <linux/if_tunnel.h>
23 #include <linux/list.h>
24 #include <linux/netlink.h>
25 #include <linux/openvswitch.h>
26 #include <linux/reciprocal_div.h>
27 #include <linux/skbuff.h>
28 #include <linux/spinlock.h>
29 #include <linux/u64_stats_sync.h>
30 #include <net/route.h>
37 /* The following definitions are for users of the vport subsytem: */
39 int ovs_vport_init(void);
40 void ovs_vport_exit(void);
42 struct vport
*ovs_vport_add(const struct vport_parms
*);
43 void ovs_vport_del(struct vport
*);
45 struct vport
*ovs_vport_locate(const struct net
*net
, const char *name
);
47 void ovs_vport_get_stats(struct vport
*, struct ovs_vport_stats
*);
49 int ovs_vport_set_options(struct vport
*, struct nlattr
*options
);
50 int ovs_vport_get_options(const struct vport
*, struct sk_buff
*);
52 int ovs_vport_set_upcall_portids(struct vport
*, const struct nlattr
*pids
);
53 int ovs_vport_get_upcall_portids(const struct vport
*, struct sk_buff
*);
54 u32
ovs_vport_find_upcall_portid(const struct vport
*, struct sk_buff
*);
56 int ovs_tunnel_get_egress_info(struct dp_upcall_info
*upcall
,
63 int ovs_vport_get_egress_tun_info(struct vport
*vport
, struct sk_buff
*skb
,
64 struct dp_upcall_info
*upcall
);
67 * struct vport_portids - array of netlink portids of a vport.
68 * must be protected by rcu.
69 * @rn_ids: The reciprocal value of @n_ids.
70 * @rcu: RCU callback head for deferred destruction.
71 * @n_ids: Size of @ids array.
72 * @ids: Array storing the Netlink socket pids to be used for packets received
73 * on this port that miss the flow table.
75 struct vport_portids
{
76 struct reciprocal_value rn_ids
;
83 * struct vport - one port within a datapath
84 * @rcu: RCU callback head for deferred destruction.
85 * @dp: Datapath to which this port belongs.
86 * @upcall_portids: RCU protected 'struct vport_portids'.
87 * @port_no: Index into @dp's @ports array.
88 * @hash_node: Element in @dev_table hash table in vport.c.
89 * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
90 * @ops: Class structure.
91 * @detach_list: list used for detaching vport in net-exit call.
94 struct net_device
*dev
;
96 struct vport_portids __rcu
*upcall_portids
;
99 struct hlist_node hash_node
;
100 struct hlist_node dp_hash_node
;
101 const struct vport_ops
*ops
;
103 struct list_head detach_list
;
108 * struct vport_parms - parameters for creating a new vport
110 * @name: New vport's name.
111 * @type: New vport's type.
112 * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
114 * @dp: New vport's datapath.
115 * @port_no: New vport's port number.
119 enum ovs_vport_type type
;
120 struct nlattr
*options
;
122 /* For ovs_vport_alloc(). */
125 struct nlattr
*upcall_portids
;
129 * struct vport_ops - definition of a type of virtual port
131 * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
132 * @create: Create a new vport configured as specified. On success returns
133 * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
134 * @destroy: Destroys a vport. Must call vport_free() on the vport but not
135 * before an RCU grace period has elapsed.
136 * @set_options: Modify the configuration of an existing vport. May be %NULL
137 * if modification is not supported.
138 * @get_options: Appends vport-specific attributes for the configuration of an
139 * existing vport to a &struct sk_buff. May be %NULL for a vport that does not
140 * have any configuration.
141 * @send: Send a packet on the device.
142 * zero for dropped packets or negative for error.
143 * @get_egress_tun_info: Get the egress tunnel 5-tuple and other info for
147 enum ovs_vport_type type
;
149 /* Called with ovs_mutex. */
150 struct vport
*(*create
)(const struct vport_parms
*);
151 void (*destroy
)(struct vport
*);
153 int (*set_options
)(struct vport
*, struct nlattr
*);
154 int (*get_options
)(const struct vport
*, struct sk_buff
*);
156 int (*get_egress_tun_info
)(struct vport
*, struct sk_buff
*,
157 struct dp_upcall_info
*upcall
);
158 netdev_tx_t (*send
)(struct sk_buff
*skb
);
160 struct module
*owner
;
161 struct list_head list
;
164 struct vport
*ovs_vport_alloc(int priv_size
, const struct vport_ops
*,
165 const struct vport_parms
*);
166 void ovs_vport_free(struct vport
*);
167 void ovs_vport_deferred_free(struct vport
*vport
);
169 #define VPORT_ALIGN 8
172 * vport_priv - access private data area of vport
174 * @vport: vport to access
176 * If a nonzero size was passed in priv_size of vport_alloc() a private data
177 * area was allocated on creation. This allows that area to be accessed and
178 * used for any purpose needed by the vport implementer.
180 static inline void *vport_priv(const struct vport
*vport
)
182 return (u8
*)(uintptr_t)vport
+ ALIGN(sizeof(struct vport
), VPORT_ALIGN
);
186 * vport_from_priv - lookup vport from private data pointer
188 * @priv: Start of private data area.
190 * It is sometimes useful to translate from a pointer to the private data
191 * area to the vport, such as in the case where the private data pointer is
192 * the result of a hash table lookup. @priv must point to the start of the
195 static inline struct vport
*vport_from_priv(void *priv
)
197 return (struct vport
*)((u8
*)priv
- ALIGN(sizeof(struct vport
), VPORT_ALIGN
));
200 int ovs_vport_receive(struct vport
*, struct sk_buff
*,
201 const struct ip_tunnel_info
*);
203 static inline void ovs_skb_postpush_rcsum(struct sk_buff
*skb
,
204 const void *start
, unsigned int len
)
206 if (skb
->ip_summed
== CHECKSUM_COMPLETE
)
207 skb
->csum
= csum_add(skb
->csum
, csum_partial(start
, len
, 0));
210 static inline const char *ovs_vport_name(struct vport
*vport
)
212 return vport
->dev
->name
;
215 int __ovs_vport_ops_register(struct vport_ops
*ops
);
216 #define ovs_vport_ops_register(ops) \
218 (ops)->owner = THIS_MODULE; \
219 __ovs_vport_ops_register(ops); \
222 void ovs_vport_ops_unregister(struct vport_ops
*ops
);
224 static inline struct rtable
*ovs_tunnel_route_lookup(struct net
*net
,
225 const struct ip_tunnel_key
*key
,
232 memset(fl
, 0, sizeof(*fl
));
233 fl
->daddr
= key
->u
.ipv4
.dst
;
234 fl
->saddr
= key
->u
.ipv4
.src
;
235 fl
->flowi4_tos
= RT_TOS(key
->tos
);
236 fl
->flowi4_mark
= mark
;
237 fl
->flowi4_proto
= protocol
;
239 rt
= ip_route_output_key(net
, fl
);
243 void ovs_vport_send(struct vport
*vport
, struct sk_buff
*skb
);