1 /* 2 * Copyright (c) 2007-2011 Nicira Networks. 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/openvswitch.h> 24 #include <linux/skbuff.h> 25 #include <linux/spinlock.h> 26 #include <linux/u64_stats_sync.h> 27 28 #include "datapath.h" 29 30 struct vport; 31 struct vport_parms; 32 33 /* The following definitions are for users of the vport subsytem: */ 34 35 int ovs_vport_init(void); 36 void ovs_vport_exit(void); 37 38 struct vport *ovs_vport_add(const struct vport_parms *); 39 void ovs_vport_del(struct vport *); 40 41 struct vport *ovs_vport_locate(const char *name); 42 43 void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *); 44 45 int ovs_vport_set_options(struct vport *, struct nlattr *options); 46 int ovs_vport_get_options(const struct vport *, struct sk_buff *); 47 48 int ovs_vport_send(struct vport *, struct sk_buff *); 49 50 /* The following definitions are for implementers of vport devices: */ 51 52 struct vport_percpu_stats { 53 u64 rx_bytes; 54 u64 rx_packets; 55 u64 tx_bytes; 56 u64 tx_packets; 57 struct u64_stats_sync sync; 58 }; 59 60 struct vport_err_stats { 61 u64 rx_dropped; 62 u64 rx_errors; 63 u64 tx_dropped; 64 u64 tx_errors; 65 }; 66 67 /** 68 * struct vport - one port within a datapath 69 * @rcu: RCU callback head for deferred destruction. 70 * @port_no: Index into @dp's @ports array. 71 * @dp: Datapath to which this port belongs. 72 * @node: Element in @dp's @port_list. 73 * @upcall_pid: The Netlink port to use for packets received on this port that 74 * miss the flow table. 75 * @hash_node: Element in @dev_table hash table in vport.c. 76 * @ops: Class structure. 77 * @percpu_stats: Points to per-CPU statistics used and maintained by vport 78 * @stats_lock: Protects @err_stats; 79 * @err_stats: Points to error statistics used and maintained by vport 80 */ 81 struct vport { 82 struct rcu_head rcu; 83 u16 port_no; 84 struct datapath *dp; 85 struct list_head node; 86 u32 upcall_pid; 87 88 struct hlist_node hash_node; 89 const struct vport_ops *ops; 90 91 struct vport_percpu_stats __percpu *percpu_stats; 92 93 spinlock_t stats_lock; 94 struct vport_err_stats err_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_pid; 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 * @get_config: Get the device's configuration. 133 * @get_ifindex: Get the system interface index associated with the device. 134 * May be null if the device does not have an ifindex. 135 * @send: Send a packet on the device. Returns the length of the packet sent. 136 */ 137 struct vport_ops { 138 enum ovs_vport_type type; 139 140 /* Called with RTNL lock. */ 141 struct vport *(*create)(const struct vport_parms *); 142 void (*destroy)(struct vport *); 143 144 int (*set_options)(struct vport *, struct nlattr *); 145 int (*get_options)(const struct vport *, struct sk_buff *); 146 147 /* Called with rcu_read_lock or RTNL lock. */ 148 const char *(*get_name)(const struct vport *); 149 void (*get_config)(const struct vport *, void *); 150 int (*get_ifindex)(const struct vport *); 151 152 int (*send)(struct vport *, struct sk_buff *); 153 }; 154 155 enum vport_err_type { 156 VPORT_E_RX_DROPPED, 157 VPORT_E_RX_ERROR, 158 VPORT_E_TX_DROPPED, 159 VPORT_E_TX_ERROR, 160 }; 161 162 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *, 163 const struct vport_parms *); 164 void ovs_vport_free(struct vport *); 165 166 #define VPORT_ALIGN 8 167 168 /** 169 * vport_priv - access private data area of vport 170 * 171 * @vport: vport to access 172 * 173 * If a nonzero size was passed in priv_size of vport_alloc() a private data 174 * area was allocated on creation. This allows that area to be accessed and 175 * used for any purpose needed by the vport implementer. 176 */ 177 static inline void *vport_priv(const struct vport *vport) 178 { 179 return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN); 180 } 181 182 /** 183 * vport_from_priv - lookup vport from private data pointer 184 * 185 * @priv: Start of private data area. 186 * 187 * It is sometimes useful to translate from a pointer to the private data 188 * area to the vport, such as in the case where the private data pointer is 189 * the result of a hash table lookup. @priv must point to the start of the 190 * private data area. 191 */ 192 static inline struct vport *vport_from_priv(const void *priv) 193 { 194 return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN)); 195 } 196 197 void ovs_vport_receive(struct vport *, struct sk_buff *); 198 void ovs_vport_record_error(struct vport *, enum vport_err_type err_type); 199 200 /* List of statically compiled vport implementations. Don't forget to also 201 * add yours to the list at the top of vport.c. */ 202 extern const struct vport_ops ovs_netdev_vport_ops; 203 extern const struct vport_ops ovs_internal_vport_ops; 204 205 #endif /* vport.h */ 206