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_addr(struct vport *, const unsigned char *);
  34 void vport_set_stats(struct vport *, struct ovs_vport_stats *);
  35
  36 const char *vport_get_name(const struct vport *);
  37 enum ovs_vport_type vport_get_type(const struct vport *);
  38 const unsigned char *vport_get_addr(const struct vport *);
  39
  40 struct kobject *vport_get_kobj(const struct vport *);
  41 void vport_get_stats(struct vport *, struct ovs_vport_stats *);
  42
  43 unsigned vport_get_flags(const struct vport *);
  44 int vport_is_running(const struct vport *);
  45 unsigned char vport_get_operstate(const struct vport *);
  46
  47 int vport_get_ifindex(const struct vport *);
  48
  49 int vport_get_mtu(const struct vport *);
  50
  51 int vport_set_options(struct vport *, struct nlattr *options);
  52 int vport_get_options(const struct vport *, struct sk_buff *);
  53
  54 int vport_send(struct vport *, struct sk_buff *);
  55
  56 /* The following definitions are for implementers of vport devices: */
  57
  58 struct vport_percpu_stats {
  59         u64 rx_bytes;
  60         u64 rx_packets;
  61         u64 tx_bytes;
  62         u64 tx_packets;
  63         seqcount_t seqlock;
  64 };
  65
  66 struct vport_err_stats {
  67         u64 rx_dropped;
  68         u64 rx_errors;
  69         u64 tx_dropped;
  70         u64 tx_errors;
  71 };
  72
  73 /**
  74  * struct vport - one port within a datapath
  75  * @rcu: RCU callback head for deferred destruction.
  76  * @port_no: Index into @dp's @ports array.
  77  * @dp: Datapath to which this port belongs.
  78  * @kobj: Represents /sys/class/net/<devname>/brport.
  79  * @linkname: The name of the link from /sys/class/net/<datapath>/brif to this
  80  * &struct vport.  (We keep this around so that we can delete it if the
  81  * device gets renamed.)  Set to the null string when no link exists.
  82  * @node: Element in @dp's @port_list.
  83  * @sflow_pool: Number of packets that were candidates for sFlow sampling,
  84  * regardless of whether they were actually chosen and sent down to userspace.
  85  * @upcall_pid: The Netlink port to use for packets received on this port that
  86  * miss the flow table.
  87  * @hash_node: Element in @dev_table hash table in vport.c.
  88  * @ops: Class structure.
  89  * @percpu_stats: Points to per-CPU statistics used and maintained by vport
  90  * @stats_lock: Protects @err_stats and @offset_stats.
  91  * @err_stats: Points to error statistics used and maintained by vport
  92  * @offset_stats: Added to actual statistics as a sop to compatibility with
  93  * XAPI for Citrix XenServer.  Deprecated.
  94  */
  95 struct vport {
  96         struct rcu_head rcu;
  97         u16 port_no;
  98         struct datapath *dp;
  99         struct kobject kobj;
 100         char linkname[IFNAMSIZ];
 101         struct list_head node;
 102         atomic_t sflow_pool;
 103         u32 upcall_pid;
 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 ovs_vport_stats offset_stats;
 113 };
 114
 115 #define VPORT_F_REQUIRED        (1 << 0) /* If init fails, module loading fails. */
 116 #define VPORT_F_FLOW            (1 << 1) /* Sets OVS_CB(skb)->flow. */
 117 #define VPORT_F_TUN_ID          (1 << 2) /* Sets OVS_CB(skb)->tun_id. */
 118
 119 /**
 120  * struct vport_parms - parameters for creating a new vport
 121  *
 122  * @name: New vport's name.
 123  * @type: New vport's type.
 124  * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
 125  * none was supplied.
 126  * @dp: New vport's datapath.
 127  * @port_no: New vport's port number.
 128  */
 129 struct vport_parms {
 130         const char *name;
 131         enum ovs_vport_type type;
 132         struct nlattr *options;
 133
 134         /* For vport_alloc(). */
 135         struct datapath *dp;
 136         u16 port_no;
 137         u32 upcall_pid;
 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_addr: Set the device's MAC address.  May be null if not supported.
 160  * @get_name: Get the device's name.
 161  * @get_addr: Get the device's MAC address.
 162  * @get_config: Get the device's configuration.
 163  * @get_kobj: Get the kobj associated with the device (may return null).
 164  * @get_dev_flags: Get the device's flags.
 165  * @is_running: Checks whether the device is running.
 166  * @get_operstate: Get the device's operating state.
 167  * @get_ifindex: Get the system interface index associated with the device.
 168  * May be null if the device does not have an ifindex.
 169  * @get_mtu: Get the device's MTU.  May be %NULL if the device does not have an
 170  * MTU (as e.g. some tunnels do not).
 171  * @send: Send a packet on the device.  Returns the length of the packet sent.
 172  */
 173 struct vport_ops {
 174         enum ovs_vport_type type;
 175         u32 flags;
 176
 177         /* Called at module init and exit respectively. */
 178         int (*init)(void);
 179         void (*exit)(void);
 180
 181         /* Called with RTNL lock. */
 182         struct vport *(*create)(const struct vport_parms *);
 183         void (*destroy)(struct vport *);
 184
 185         int (*set_options)(struct vport *, struct nlattr *);
 186         int (*get_options)(const struct vport *, struct sk_buff *);
 187
 188         int (*set_addr)(struct vport *, const unsigned char *);
 189
 190         /* Called with rcu_read_lock or RTNL lock. */
 191         const char *(*get_name)(const struct vport *);
 192         const unsigned char *(*get_addr)(const struct vport *);
 193         void (*get_config)(const struct vport *, void *);
 194         struct kobject *(*get_kobj)(const struct vport *);
 195
 196         unsigned (*get_dev_flags)(const struct vport *);
 197         int (*is_running)(const struct vport *);
 198         unsigned char (*get_operstate)(const struct vport *);
 199
 200         int (*get_ifindex)(const struct vport *);
 201
 202         int (*get_mtu)(const struct vport *);
 203
 204         int (*send)(struct vport *, struct sk_buff *);
 205 };
 206
 207 enum vport_err_type {
 208         VPORT_E_RX_DROPPED,
 209         VPORT_E_RX_ERROR,
 210         VPORT_E_TX_DROPPED,
 211         VPORT_E_TX_ERROR,
 212 };
 213
 214 struct vport *vport_alloc(int priv_size, const struct vport_ops *, const struct vport_parms *);
 215 void vport_free(struct vport *);
 216
 217 #define VPORT_ALIGN 8
 218
 219 /**
 220  *      vport_priv - access private data area of vport
 221  *
 222  * @vport: vport to access
 223  *
 224  * If a nonzero size was passed in priv_size of vport_alloc() a private data
 225  * area was allocated on creation.  This allows that area to be accessed and
 226  * used for any purpose needed by the vport implementer.
 227  */
 228 static inline void *vport_priv(const struct vport *vport)
 229 {
 230         return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
 231 }
 232
 233 /**
 234  *      vport_from_priv - lookup vport from private data pointer
 235  *
 236  * @priv: Start of private data area.
 237  *
 238  * It is sometimes useful to translate from a pointer to the private data
 239  * area to the vport, such as in the case where the private data pointer is
 240  * the result of a hash table lookup.  @priv must point to the start of the
 241  * private data area.
 242  */
 243 static inline struct vport *vport_from_priv(const void *priv)
 244 {
 245         return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
 246 }
 247
 248 void vport_receive(struct vport *, struct sk_buff *);
 249 void vport_record_error(struct vport *, enum vport_err_type err_type);
 250
 251 /* List of statically compiled vport implementations.  Don't forget to also
 252  * add yours to the list at the top of vport.c. */
 253 extern const struct vport_ops netdev_vport_ops;
 254 extern const struct vport_ops internal_vport_ops;
 255 extern const struct vport_ops patch_vport_ops;
 256 extern const struct vport_ops gre_vport_ops;
 257 extern const struct vport_ops capwap_vport_ops;
 258
 259 #endif /* vport.h */