datapath/vport.h

   1 /*
   2  * Copyright (c) 2010 Nicira Networks.
   3  * Distributed under the terms of the GNU GPL version 2.
   4  *
   5  * Significant portions of this file may be copied from parts of the Linux
   6  * kernel, by Linus Torvalds and others.
   7  */
   8
   9 #ifndef VPORT_H
  10 #define VPORT_H 1
  11
  12 #include <linux/list.h>
  13 #include <linux/seqlock.h>
  14 #include <linux/skbuff.h>
  15 #include <linux/spinlock.h>
  16
  17 #include "datapath.h"
  18 #include "openvswitch/datapath-protocol.h"
  19 #include "odp-compat.h"
  20
  21 struct vport;
  22 struct vport_parms;
  23
  24 /* The following definitions are for users of the vport subsytem: */
  25
  26 int vport_user_mod(const struct odp_port __user *);
  27
  28 int vport_user_stats_get(struct odp_vport_stats_req __user *);
  29 int vport_user_stats_set(struct odp_vport_stats_req __user *);
  30 int vport_user_ether_get(struct odp_vport_ether __user *);
  31 int vport_user_ether_set(struct odp_vport_ether __user *);
  32 int vport_user_mtu_get(struct odp_vport_mtu __user *);
  33 int vport_user_mtu_set(struct odp_vport_mtu __user *);
  34
  35 void vport_lock(void);
  36 void vport_unlock(void);
  37
  38 int vport_init(void);
  39 void vport_exit(void);
  40
  41 struct vport *vport_add(const struct vport_parms *);
  42 int vport_mod(struct vport *, struct odp_port *);
  43 int vport_del(struct vport *);
  44
  45 struct vport *vport_locate(const char *name);
  46
  47 int vport_set_mtu(struct vport *, int mtu);
  48 int vport_set_addr(struct vport *, const unsigned char *);
  49 int vport_set_stats(struct vport *, struct rtnl_link_stats64 *);
  50
  51 const char *vport_get_name(const struct vport *);
  52 const char *vport_get_type(const struct vport *);
  53 const unsigned char *vport_get_addr(const struct vport *);
  54
  55 struct kobject *vport_get_kobj(const struct vport *);
  56 int vport_get_stats(struct vport *, struct rtnl_link_stats64 *);
  57
  58 unsigned vport_get_flags(const struct vport *);
  59 int vport_is_running(const struct vport *);
  60 unsigned char vport_get_operstate(const struct vport *);
  61
  62 int vport_get_ifindex(const struct vport *);
  63 int vport_get_iflink(const struct vport *);
  64
  65 int vport_get_mtu(const struct vport *);
  66 void vport_get_config(const struct vport *, void *);
  67
  68 int vport_send(struct vport *, struct sk_buff *);
  69
  70 /* The following definitions are for implementers of vport devices: */
  71
  72 struct vport_percpu_stats {
  73         u64 rx_bytes;
  74         u64 rx_packets;
  75         u64 tx_bytes;
  76         u64 tx_packets;
  77         seqcount_t seqlock;
  78 };
  79
  80 struct vport_err_stats {
  81         u64 rx_dropped;
  82         u64 rx_errors;
  83         u64 tx_dropped;
  84         u64 tx_errors;
  85 };
  86
  87 /**
  88  * struct vport - one port within a datapath
  89  * @port_no: Index into @dp's @ports array.
  90  * @dp: Datapath to which this port belongs.
  91  * @kobj: Represents /sys/class/net/<devname>/brport.
  92  * @linkname: The name of the link from /sys/class/net/<datapath>/brif to this
  93  * &struct vport.  (We keep this around so that we can delete it if the
  94  * device gets renamed.)  Set to the null string when no link exists.
  95  * @node: Element in @dp's @port_list.
  96  * @sflow_pool: Number of packets that were candidates for sFlow sampling,
  97  * regardless of whether they were actually chosen and sent down to userspace.
  98  * @hash_node: Element in @dev_table hash table in vport.c.
  99  * @ops: Class structure.
 100  * @percpu_stats: Points to per-CPU statistics used and maintained by the vport
 101  * code if %VPORT_F_GEN_STATS is set to 1 in @ops flags, otherwise unused.
 102  * @stats_lock: Protects @err_stats and @offset_stats.
 103  * @err_stats: Points to error statistics used and maintained by the vport code
 104  * if %VPORT_F_GEN_STATS is set to 1 in @ops flags, otherwise unused.
 105  * @offset_stats: Added to actual statistics as a sop to compatibility with
 106  * XAPI for Citrix XenServer.  Deprecated.
 107  */
 108 struct vport {
 109         u16 port_no;
 110         struct datapath *dp;
 111         struct kobject kobj;
 112         char linkname[IFNAMSIZ];
 113         struct list_head node;
 114         atomic_t sflow_pool;
 115
 116         struct hlist_node hash_node;
 117         const struct vport_ops *ops;
 118
 119         struct vport_percpu_stats __percpu *percpu_stats;
 120
 121         spinlock_t stats_lock;
 122         struct vport_err_stats err_stats;
 123         struct rtnl_link_stats64 offset_stats;
 124 };
 125
 126 #define VPORT_F_REQUIRED        (1 << 0) /* If init fails, module loading fails. */
 127 #define VPORT_F_GEN_STATS       (1 << 1) /* Track stats at the generic layer. */
 128 #define VPORT_F_FLOW            (1 << 2) /* Sets OVS_CB(skb)->flow. */
 129 #define VPORT_F_TUN_ID          (1 << 3) /* Sets OVS_CB(skb)->tun_id. */
 130
 131 /**
 132  * struct vport_parms - parameters for creating a new vport
 133  *
 134  * @name: New vport's name.
 135  * @type: New vport's type.
 136  * @config: Kernel copy of 'config' member of &struct odp_port describing
 137  * configuration for new port.  Exactly %VPORT_CONFIG_SIZE bytes.
 138  * @dp: New vport's datapath.
 139  * @port_no: New vport's port number.
 140  */
 141 struct vport_parms {
 142         const char *name;
 143         const char *type;
 144         const void *config;
 145
 146         /* For vport_alloc(). */
 147         struct datapath *dp;
 148         u16 port_no;
 149 };
 150
 151 /**
 152  * struct vport_ops - definition of a type of virtual port
 153  *
 154  * @type: Name of port type, such as "netdev" or "internal" to be matched
 155  * against the device type when a new port needs to be created.
 156  * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
 157  * handles this vport.
 158  * @init: Called at module initialization.  If VPORT_F_REQUIRED is set then the
 159  * failure of this function will cause the module to not load.  If the flag is
 160  * not set and initialzation fails then no vports of this type can be created.
 161  * @exit: Called at module unload.
 162  * @create: Create a new vport configured as specified.  On success returns
 163  * a new vport allocated with vport_alloc(), otherwise an ERR_PTR() value.
 164  * @modify: Modify the configuration of an existing vport.  May be null if
 165  * modification is not supported.
 166  * @destroy: Detach and destroy a vport.
 167  * @set_mtu: Set the device's MTU.  May be null if not supported.
 168  * @set_addr: Set the device's MAC address.  May be null if not supported.
 169  * @set_stats: Provides stats as an offset to be added to the device stats.
 170  * May be null if not supported.
 171  * @get_name: Get the device's name.
 172  * @get_addr: Get the device's MAC address.
 173  * @get_config: Get the device's configuration.
 174  * @get_kobj: Get the kobj associated with the device (may return null).
 175  * @get_stats: Fill in the transmit/receive stats.  May be null if stats are
 176  * not supported or if generic stats are in use.  If defined and
 177  * VPORT_F_GEN_STATS is also set, the error stats are added to those already
 178  * collected.
 179  * @get_dev_flags: Get the device's flags.
 180  * @is_running: Checks whether the device is running.
 181  * @get_operstate: Get the device's operating state.
 182  * @get_ifindex: Get the system interface index associated with the device.
 183  * May be null if the device does not have an ifindex.
 184  * @get_iflink: Get the system interface index associated with the device that
 185  * will be used to send packets (may be different than ifindex for tunnels).
 186  * May be null if the device does not have an iflink.
 187  * @get_mtu: Get the device's MTU.
 188  * @send: Send a packet on the device.  Returns the length of the packet sent.
 189  */
 190 struct vport_ops {
 191         const char *type;
 192         u32 flags;
 193
 194         /* Called at module init and exit respectively. */
 195         int (*init)(void);
 196         void (*exit)(void);
 197
 198         /* Called with RTNL lock. */
 199         struct vport *(*create)(const struct vport_parms *);
 200         int (*modify)(struct vport *, struct odp_port *);
 201         int (*destroy)(struct vport *);
 202
 203         int (*set_mtu)(struct vport *, int mtu);
 204         int (*set_addr)(struct vport *, const unsigned char *);
 205         int (*set_stats)(const struct vport *, struct rtnl_link_stats64 *);
 206
 207         /* Called with rcu_read_lock or RTNL lock. */
 208         const char *(*get_name)(const struct vport *);
 209         const unsigned char *(*get_addr)(const struct vport *);
 210         void (*get_config)(const struct vport *, void *);
 211         struct kobject *(*get_kobj)(const struct vport *);
 212         int (*get_stats)(const struct vport *, struct rtnl_link_stats64 *);
 213
 214         unsigned (*get_dev_flags)(const struct vport *);
 215         int (*is_running)(const struct vport *);
 216         unsigned char (*get_operstate)(const struct vport *);
 217
 218         int (*get_ifindex)(const struct vport *);
 219         int (*get_iflink)(const struct vport *);
 220
 221         int (*get_mtu)(const struct vport *);
 222
 223         int (*send)(struct vport *, struct sk_buff *);
 224 };
 225
 226 enum vport_err_type {
 227         VPORT_E_RX_DROPPED,
 228         VPORT_E_RX_ERROR,
 229         VPORT_E_TX_DROPPED,
 230         VPORT_E_TX_ERROR,
 231 };
 232
 233 struct vport *vport_alloc(int priv_size, const struct vport_ops *, const struct vport_parms *);
 234 void vport_free(struct vport *);
 235
 236 #define VPORT_ALIGN 8
 237
 238 /**
 239  *      vport_priv - access private data area of vport
 240  *
 241  * @vport: vport to access
 242  *
 243  * If a nonzero size was passed in priv_size of vport_alloc() a private data
 244  * area was allocated on creation.  This allows that area to be accessed and
 245  * used for any purpose needed by the vport implementer.
 246  */
 247 static inline void *vport_priv(const struct vport *vport)
 248 {
 249         return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
 250 }
 251
 252 /**
 253  *      vport_from_priv - lookup vport from private data pointer
 254  *
 255  * @priv: Start of private data area.
 256  *
 257  * It is sometimes useful to translate from a pointer to the private data
 258  * area to the vport, such as in the case where the private data pointer is
 259  * the result of a hash table lookup.  @priv must point to the start of the
 260  * private data area.
 261  */
 262 static inline struct vport *vport_from_priv(const void *priv)
 263 {
 264         return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
 265 }
 266
 267 void vport_receive(struct vport *, struct sk_buff *);
 268 void vport_record_error(struct vport *, enum vport_err_type err_type);
 269
 270 /* List of statically compiled vport implementations.  Don't forget to also
 271  * add yours to the list at the top of vport.c. */
 272 extern const struct vport_ops netdev_vport_ops;
 273 extern const struct vport_ops internal_vport_ops;
 274 extern const struct vport_ops patch_vport_ops;
 275 extern const struct vport_ops gre_vport_ops;
 276 extern const struct vport_ops capwap_vport_ops;
 277
 278 #endif /* vport.h */