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/skbuff.h>
  14 #include <linux/spinlock.h>
  15
  16 #include "datapath.h"
  17 #include "openvswitch/datapath-protocol.h"
  18 #include "odp-compat.h"
  19
  20 struct vport;
  21 struct dp_port;
  22
  23 /* The following definitions are for users of the vport subsytem: */
  24
  25 void vport_lock(void);
  26 void vport_unlock(void);
  27
  28 int vport_init(void);
  29 void vport_exit(void);
  30
  31 int vport_add(const struct odp_vport_add __user *);
  32 int vport_mod(const struct odp_vport_mod __user *);
  33 int vport_del(const char __user *udevname);
  34
  35 #ifdef CONFIG_COMPAT
  36 int compat_vport_add(struct compat_odp_vport_add __user *);
  37 int compat_vport_mod(struct compat_odp_vport_mod __user *);
  38 #endif
  39
  40 int vport_stats_get(struct odp_vport_stats_req __user *);
  41 int vport_ether_get(struct odp_vport_ether __user *);
  42 int vport_ether_set(struct odp_vport_ether __user *);
  43 int vport_mtu_get(struct odp_vport_mtu __user *);
  44 int vport_mtu_set(struct odp_vport_mtu __user *);
  45
  46 struct vport *__vport_add(const char *name, const char *type, const void __user *config);
  47 int __vport_mod(struct vport *, const void __user *config);
  48 int __vport_del(struct vport *);
  49
  50 struct vport *vport_locate(const char *name);
  51
  52 int vport_attach(struct vport *, struct dp_port *);
  53 int vport_detach(struct vport *);
  54
  55 int vport_set_mtu(struct vport *, int mtu);
  56 int vport_set_addr(struct vport *, const unsigned char *);
  57
  58 const char *vport_get_name(const struct vport *);
  59 const char *vport_get_type(const struct vport *);
  60 const unsigned char *vport_get_addr(const struct vport *);
  61
  62 struct dp_port *vport_get_dp_port(const struct vport *);
  63
  64 struct kobject *vport_get_kobj(const struct vport *);
  65
  66 unsigned vport_get_flags(const struct vport *);
  67 int vport_is_running(const struct vport *);
  68 unsigned char vport_get_operstate(const struct vport *);
  69
  70 int vport_get_ifindex(const struct vport *);
  71 int vport_get_iflink(const struct vport *);
  72
  73 int vport_get_mtu(const struct vport *);
  74
  75 int vport_send(struct vport *, struct sk_buff *);
  76
  77 /* The following definitions are for implementers of vport devices: */
  78
  79 struct vport_percpu_stats {
  80         u64 rx_bytes;
  81         u64 rx_packets;
  82         u64 tx_bytes;
  83         u64 tx_packets;
  84 };
  85
  86 struct vport_err_stats {
  87         spinlock_t lock;
  88
  89         u64 rx_dropped;
  90         u64 rx_errors;
  91         u64 rx_frame_err;
  92         u64 rx_over_err;
  93         u64 rx_crc_err;
  94         u64 tx_dropped;
  95         u64 tx_errors;
  96         u64 collisions;
  97 };
  98
  99 struct vport {
 100         struct hlist_node hash_node;
 101         const struct vport_ops *ops;
 102         struct dp_port *dp_port;
 103
 104         struct vport_percpu_stats *percpu_stats;
 105         struct vport_err_stats err_stats;
 106 };
 107
 108 #define VPORT_F_REQUIRED        (1 << 0) /* If init fails, module loading fails. */
 109 #define VPORT_F_GEN_STATS       (1 << 1) /* Track stats at the generic layer. */
 110 #define VPORT_F_TUN_ID          (1 << 2) /* Sets OVS_CB(skb)->tun_id. */
 111
 112 /**
 113  * struct vport_ops - definition of a type of virtual port
 114  *
 115  * @type: Name of port type, such as "netdev" or "internal" to be matched
 116  * against the device type when a new port needs to be created.
 117  * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
 118  * handles this vport.
 119  * @init: Called at module initialization.  If VPORT_F_REQUIRED is set then the
 120  * failure of this function will cause the module to not load.  If the flag is
 121  * not set and initialzation fails then no vports of this type can be created.
 122  * @exit: Called at module unload.
 123  * @create: Create a new vport called 'name' with vport type specific
 124  * configuration 'config' (which must be copied from userspace before use).  On
 125  * success must allocate a new vport using vport_alloc().
 126  * @modify: Modify the configuration of an existing vport.  May be null if
 127  * modification is not supported.
 128  * @destroy: Destroy and free a vport using vport_free().  Prior to destruction
 129  * @detach will be called followed by synchronize_rcu().
 130  * @attach: Attach a previously created vport to a datapath.  After attachment
 131  * packets may be sent and received.  Prior to attachment any packets may be
 132  * silently discarded.  May be null if not needed.
 133  * @detach: Detach a vport from a datapath.  May be null if not needed.
 134  * @set_mtu: Set the device's MTU.  May be null if not supported.
 135  * @set_addr: Set the device's MAC address.  May be null if not supported.
 136  * @get_name: Get the device's name.
 137  * @get_addr: Get the device's MAC address.
 138  * @get_kobj: Get the kobj associated with the device (may return null).
 139  * @get_stats: Fill in the transmit/receive stats.  May be null if stats are
 140  * not supported or if generic stats are in use.  If defined overrides
 141  * VPORT_F_GEN_STATS.
 142  * @get_dev_flags: Get the device's flags.
 143  * @is_running: Checks whether the device is running.
 144  * @get_operstate: Get the device's operating state.
 145  * @get_ifindex: Get the system interface index associated with the device.
 146  * May be null if the device does not have an ifindex.
 147  * @get_iflink: Get the system interface index associated with the device that
 148  * will be used to send packets (may be different than ifindex for tunnels).
 149  * May be null if the device does not have an iflink.
 150  * @get_mtu: Get the device's MTU.
 151  * @send: Send a packet on the device.  Returns the length of the packet sent.
 152  */
 153 struct vport_ops {
 154         const char *type;
 155         u32 flags;
 156
 157         /* Called at module init and exit respectively. */
 158         int (*init)(void);
 159         void (*exit)(void);
 160
 161         /* Called with RTNL lock. */
 162         struct vport *(*create)(const char *name, const void __user *config);
 163         int (*modify)(struct vport *, const void __user *config);
 164         int (*destroy)(struct vport *);
 165
 166         int (*attach)(struct vport *);
 167         int (*detach)(struct vport *);
 168
 169         int (*set_mtu)(struct vport *, int mtu);
 170         int (*set_addr)(struct vport *, const unsigned char *);
 171
 172         /* Called with rcu_read_lock or RTNL lock. */
 173         const char *(*get_name)(const struct vport *);
 174         const unsigned char *(*get_addr)(const struct vport *);
 175         struct kobject *(*get_kobj)(const struct vport *);
 176         int (*get_stats)(const struct vport *, struct odp_vport_stats *);
 177
 178         unsigned (*get_dev_flags)(const struct vport *);
 179         int (*is_running)(const struct vport *);
 180         unsigned char (*get_operstate)(const struct vport *);
 181
 182         int (*get_ifindex)(const struct vport *);
 183         int (*get_iflink)(const struct vport *);
 184
 185         int (*get_mtu)(const struct vport *);
 186
 187         int (*send)(struct vport *, struct sk_buff *);
 188 };
 189
 190 enum vport_err_type {
 191         VPORT_E_RX_DROPPED,
 192         VPORT_E_RX_ERROR,
 193         VPORT_E_RX_FRAME,
 194         VPORT_E_RX_OVER,
 195         VPORT_E_RX_CRC,
 196         VPORT_E_TX_DROPPED,
 197         VPORT_E_TX_ERROR,
 198         VPORT_E_COLLISION,
 199 };
 200
 201 struct vport *vport_alloc(int priv_size, const struct vport_ops *);
 202 void vport_free(struct vport *);
 203
 204 #define VPORT_ALIGN 8
 205
 206 /**
 207  *      vport_priv - access private data area of vport
 208  *
 209  * @vport: vport to access
 210  *
 211  * If a nonzero size was passed in priv_size of vport_alloc() a private data
 212  * area was allocated on creation.  This allows that area to be accessed and
 213  * used for any purpose needed by the vport implementer.
 214  */
 215 static inline void *
 216 vport_priv(const struct vport *vport)
 217 {
 218         return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
 219 }
 220
 221 /**
 222  *      vport_from_priv - lookup vport from private data pointer
 223  *
 224  * @priv: Start of private data area.
 225  *
 226  * It is sometimes useful to translate from a pointer to the private data
 227  * area to the vport, such as in the case where the private data pointer is
 228  * the result of a hash table lookup.  @priv must point to the start of the
 229  * private data area.
 230  */
 231 static inline struct vport *
 232 vport_from_priv(const void *priv)
 233 {
 234         return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
 235 }
 236
 237 void vport_receive(struct vport *, struct sk_buff *);
 238 void vport_record_error(struct vport *, enum vport_err_type err_type);
 239
 240 #endif /* vport.h */