pintos-os.org Git - openvswitch/blob - datapath/vport.h

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