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/reciprocal_div.h> 27 #include <linux/skbuff.h> 28 #include <linux/spinlock.h> 29 #include <linux/u64_stats_sync.h> 30 31 #include "datapath.h" 32 33 struct vport; 34 struct vport_parms; 35 36 /* The following definitions are for users of the vport subsytem: */ 37 38 struct vport_net { 39 struct vport __rcu *gre_vport; 40 }; 41 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 48 struct vport *ovs_vport_locate(const struct net *net, const char *name); 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_set_upcall_portids(struct vport *, const struct nlattr *pids); 56 int ovs_vport_get_upcall_portids(const struct vport *, struct sk_buff *); 57 u32 ovs_vport_find_upcall_portid(const struct vport *, struct sk_buff *); 58 59 int ovs_vport_send(struct vport *, struct sk_buff *); 60 61 int ovs_tunnel_get_egress_info(struct ovs_tunnel_info *egress_tun_info, 62 struct net *net, 63 const struct ovs_tunnel_info *tun_info, 64 u8 ipproto, 65 u32 skb_mark, 66 __be16 tp_src, 67 __be16 tp_dst); 68 int ovs_vport_get_egress_tun_info(struct vport *vport, struct sk_buff *skb, 69 struct ovs_tunnel_info *info); 70 71 /* The following definitions are for implementers of vport devices: */ 72 73 struct vport_err_stats { 74 atomic_long_t rx_dropped; 75 atomic_long_t rx_errors; 76 atomic_long_t tx_dropped; 77 atomic_long_t tx_errors; 78 }; 79 /** 80 * struct vport_portids - array of netlink portids of a vport. 81 * must be protected by rcu. 82 * @rn_ids: The reciprocal value of @n_ids. 83 * @rcu: RCU callback head for deferred destruction. 84 * @n_ids: Size of @ids array. 85 * @ids: Array storing the Netlink socket pids to be used for packets received 86 * on this port that miss the flow table. 87 */ 88 struct vport_portids { 89 struct reciprocal_value rn_ids; 90 struct rcu_head rcu; 91 u32 n_ids; 92 u32 ids[]; 93 }; 94 95 /** 96 * struct vport - one port within a datapath 97 * @rcu: RCU callback head for deferred destruction. 98 * @dp: Datapath to which this port belongs. 99 * @upcall_portids: RCU protected 'struct vport_portids'. 100 * @port_no: Index into @dp's @ports array. 101 * @hash_node: Element in @dev_table hash table in vport.c. 102 * @dp_hash_node: Element in @datapath->ports hash table in datapath.c. 103 * @ops: Class structure. 104 * @percpu_stats: Points to per-CPU statistics used and maintained by vport 105 * @err_stats: Points to error statistics used and maintained by vport 106 * @detach_list: list used for detaching vport in net-exit call. 107 */ 108 struct vport { 109 struct rcu_head rcu; 110 struct datapath *dp; 111 struct vport_portids __rcu *upcall_portids; 112 u16 port_no; 113 114 struct hlist_node hash_node; 115 struct hlist_node dp_hash_node; 116 const struct vport_ops *ops; 117 118 struct pcpu_sw_netstats __percpu *percpu_stats; 119 120 struct vport_err_stats err_stats; 121 struct list_head detach_list; 122 }; 123 124 /** 125 * struct vport_parms - parameters for creating a new vport 126 * 127 * @name: New vport's name. 128 * @type: New vport's type. 129 * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if 130 * none was supplied. 131 * @dp: New vport's datapath. 132 * @port_no: New vport's port number. 133 */ 134 struct vport_parms { 135 const char *name; 136 enum ovs_vport_type type; 137 struct nlattr *options; 138 139 /* For ovs_vport_alloc(). */ 140 struct datapath *dp; 141 u16 port_no; 142 struct nlattr *upcall_portids; 143 }; 144 145 /** 146 * struct vport_ops - definition of a type of virtual port 147 * 148 * @type: %OVS_VPORT_TYPE_* value for this type of virtual port. 149 * @create: Create a new vport configured as specified. On success returns 150 * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value. 151 * @destroy: Destroys a vport. Must call vport_free() on the vport but not 152 * before an RCU grace period has elapsed. 153 * @set_options: Modify the configuration of an existing vport. May be %NULL 154 * if modification is not supported. 155 * @get_options: Appends vport-specific attributes for the configuration of an 156 * existing vport to a &struct sk_buff. May be %NULL for a vport that does not 157 * have any configuration. 158 * @get_name: Get the device's name. 159 * @send: Send a packet on the device. Returns the length of the packet sent, 160 * zero for dropped packets or negative for error. 161 * @get_egress_tun_info: Get the egress tunnel 5-tuple and other info for 162 * a packet. 163 */ 164 struct vport_ops { 165 enum ovs_vport_type type; 166 167 /* Called with ovs_mutex. */ 168 struct vport *(*create)(const struct vport_parms *); 169 void (*destroy)(struct vport *); 170 171 int (*set_options)(struct vport *, struct nlattr *); 172 int (*get_options)(const struct vport *, struct sk_buff *); 173 174 /* Called with rcu_read_lock or ovs_mutex. */ 175 const char *(*get_name)(const struct vport *); 176 177 int (*send)(struct vport *, struct sk_buff *); 178 int (*get_egress_tun_info)(struct vport *, struct sk_buff *, 179 struct ovs_tunnel_info *); 180 181 struct module *owner; 182 struct list_head list; 183 }; 184 185 enum vport_err_type { 186 VPORT_E_RX_DROPPED, 187 VPORT_E_RX_ERROR, 188 VPORT_E_TX_DROPPED, 189 VPORT_E_TX_ERROR, 190 }; 191 192 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *, 193 const struct vport_parms *); 194 void ovs_vport_free(struct vport *); 195 void ovs_vport_deferred_free(struct vport *vport); 196 197 #define VPORT_ALIGN 8 198 199 /** 200 * vport_priv - access private data area of vport 201 * 202 * @vport: vport to access 203 * 204 * If a nonzero size was passed in priv_size of vport_alloc() a private data 205 * area was allocated on creation. This allows that area to be accessed and 206 * used for any purpose needed by the vport implementer. 207 */ 208 static inline void *vport_priv(const struct vport *vport) 209 { 210 return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN); 211 } 212 213 /** 214 * vport_from_priv - lookup vport from private data pointer 215 * 216 * @priv: Start of private data area. 217 * 218 * It is sometimes useful to translate from a pointer to the private data 219 * area to the vport, such as in the case where the private data pointer is 220 * the result of a hash table lookup. @priv must point to the start of the 221 * private data area. 222 */ 223 static inline struct vport *vport_from_priv(void *priv) 224 { 225 return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN)); 226 } 227 228 void ovs_vport_receive(struct vport *, struct sk_buff *, 229 const struct ovs_tunnel_info *); 230 231 static inline void ovs_skb_postpush_rcsum(struct sk_buff *skb, 232 const void *start, unsigned int len) 233 { 234 if (skb->ip_summed == CHECKSUM_COMPLETE) 235 skb->csum = csum_add(skb->csum, csum_partial(start, len, 0)); 236 } 237 238 int ovs_vport_ops_register(struct vport_ops *ops); 239 void ovs_vport_ops_unregister(struct vport_ops *ops); 240 241 static inline struct rtable *ovs_tunnel_route_lookup(struct net *net, 242 const struct ovs_key_ipv4_tunnel *key, 243 u32 mark, 244 struct flowi4 *fl, 245 u8 protocol) 246 { 247 struct rtable *rt; 248 249 memset(fl, 0, sizeof(*fl)); 250 fl->daddr = key->ipv4_dst; 251 fl->saddr = key->ipv4_src; 252 fl->flowi4_tos = RT_TOS(key->ipv4_tos); 253 fl->flowi4_mark = mark; 254 fl->flowi4_proto = protocol; 255 256 rt = ip_route_output_key(net, fl); 257 return rt; 258 } 259 #endif /* vport.h */ 260