1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright (c) 2007-2012 Nicira, Inc. 4 */ 5 6 #ifndef VPORT_H 7 #define VPORT_H 1 8 9 #include <linux/if_tunnel.h> 10 #include <linux/list.h> 11 #include <linux/netlink.h> 12 #include <linux/openvswitch.h> 13 #include <linux/reciprocal_div.h> 14 #include <linux/skbuff.h> 15 #include <linux/spinlock.h> 16 #include <linux/u64_stats_sync.h> 17 18 #include "datapath.h" 19 20 struct vport; 21 struct vport_parms; 22 23 /* The following definitions are for users of the vport subsystem: */ 24 25 int ovs_vport_init(void); 26 void ovs_vport_exit(void); 27 28 struct vport *ovs_vport_add(const struct vport_parms *); 29 void ovs_vport_del(struct vport *); 30 31 struct vport *ovs_vport_locate(const struct net *net, const char *name); 32 33 void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *); 34 35 int ovs_vport_set_options(struct vport *, struct nlattr *options); 36 int ovs_vport_get_options(const struct vport *, struct sk_buff *); 37 38 int ovs_vport_set_upcall_portids(struct vport *, const struct nlattr *pids); 39 int ovs_vport_get_upcall_portids(const struct vport *, struct sk_buff *); 40 u32 ovs_vport_find_upcall_portid(const struct vport *, struct sk_buff *); 41 42 /** 43 * struct vport_portids - array of netlink portids of a vport. 44 * must be protected by rcu. 45 * @rn_ids: The reciprocal value of @n_ids. 46 * @rcu: RCU callback head for deferred destruction. 47 * @n_ids: Size of @ids array. 48 * @ids: Array storing the Netlink socket pids to be used for packets received 49 * on this port that miss the flow table. 50 */ 51 struct vport_portids { 52 struct reciprocal_value rn_ids; 53 struct rcu_head rcu; 54 u32 n_ids; 55 u32 ids[]; 56 }; 57 58 /** 59 * struct vport - one port within a datapath 60 * @dev: Pointer to net_device. 61 * @dp: Datapath to which this port belongs. 62 * @upcall_portids: RCU protected 'struct vport_portids'. 63 * @port_no: Index into @dp's @ports array. 64 * @hash_node: Element in @dev_table hash table in vport.c. 65 * @dp_hash_node: Element in @datapath->ports hash table in datapath.c. 66 * @ops: Class structure. 67 * @detach_list: list used for detaching vport in net-exit call. 68 * @rcu: RCU callback head for deferred destruction. 69 */ 70 struct vport { 71 struct net_device *dev; 72 struct datapath *dp; 73 struct vport_portids __rcu *upcall_portids; 74 u16 port_no; 75 76 struct hlist_node hash_node; 77 struct hlist_node dp_hash_node; 78 const struct vport_ops *ops; 79 80 struct list_head detach_list; 81 struct rcu_head rcu; 82 }; 83 84 /** 85 * struct vport_parms - parameters for creating a new vport 86 * 87 * @name: New vport's name. 88 * @type: New vport's type. 89 * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if 90 * none was supplied. 91 * @dp: New vport's datapath. 92 * @port_no: New vport's port number. 93 */ 94 struct vport_parms { 95 const char *name; 96 enum ovs_vport_type type; 97 struct nlattr *options; 98 99 /* For ovs_vport_alloc(). */ 100 struct datapath *dp; 101 u16 port_no; 102 struct nlattr *upcall_portids; 103 }; 104 105 /** 106 * struct vport_ops - definition of a type of virtual port 107 * 108 * @type: %OVS_VPORT_TYPE_* value for this type of virtual port. 109 * @create: Create a new vport configured as specified. On success returns 110 * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value. 111 * @destroy: Destroys a vport. Must call vport_free() on the vport but not 112 * before an RCU grace period has elapsed. 113 * @set_options: Modify the configuration of an existing vport. May be %NULL 114 * if modification is not supported. 115 * @get_options: Appends vport-specific attributes for the configuration of an 116 * existing vport to a &struct sk_buff. May be %NULL for a vport that does not 117 * have any configuration. 118 * @send: Send a packet on the device. 119 * zero for dropped packets or negative for error. 120 */ 121 struct vport_ops { 122 enum ovs_vport_type type; 123 124 /* Called with ovs_mutex. */ 125 struct vport *(*create)(const struct vport_parms *); 126 void (*destroy)(struct vport *); 127 128 int (*set_options)(struct vport *, struct nlattr *); 129 int (*get_options)(const struct vport *, struct sk_buff *); 130 131 netdev_tx_t (*send) (struct sk_buff *skb); 132 struct module *owner; 133 struct list_head list; 134 }; 135 136 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *, 137 const struct vport_parms *); 138 void ovs_vport_free(struct vport *); 139 140 #define VPORT_ALIGN 8 141 142 /** 143 * vport_priv - access private data area of vport 144 * 145 * @vport: vport to access 146 * 147 * If a nonzero size was passed in priv_size of vport_alloc() a private data 148 * area was allocated on creation. This allows that area to be accessed and 149 * used for any purpose needed by the vport implementer. 150 */ 151 static inline void *vport_priv(const struct vport *vport) 152 { 153 return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN); 154 } 155 156 /** 157 * vport_from_priv - lookup vport from private data pointer 158 * 159 * @priv: Start of private data area. 160 * 161 * It is sometimes useful to translate from a pointer to the private data 162 * area to the vport, such as in the case where the private data pointer is 163 * the result of a hash table lookup. @priv must point to the start of the 164 * private data area. 165 */ 166 static inline struct vport *vport_from_priv(void *priv) 167 { 168 return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN)); 169 } 170 171 int ovs_vport_receive(struct vport *, struct sk_buff *, 172 const struct ip_tunnel_info *); 173 174 static inline const char *ovs_vport_name(struct vport *vport) 175 { 176 return vport->dev->name; 177 } 178 179 int __ovs_vport_ops_register(struct vport_ops *ops); 180 #define ovs_vport_ops_register(ops) \ 181 ({ \ 182 (ops)->owner = THIS_MODULE; \ 183 __ovs_vport_ops_register(ops); \ 184 }) 185 186 void ovs_vport_ops_unregister(struct vport_ops *ops); 187 void ovs_vport_send(struct vport *vport, struct sk_buff *skb, u8 mac_proto); 188 189 #endif /* vport.h */ 190