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