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