datapath/vport.h

   1 /*
   2  * Copyright (c) 2007-2012 Nicira, Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of version 2 of the GNU General Public
   6  * License as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  16  * 02110-1301, USA
  17  */
  18
  19 #ifndef VPORT_H
  20 #define VPORT_H 1
  21
  22 #include <linux/list.h>
  23 #include <linux/netlink.h>
  24 #include <linux/openvswitch.h>
  25 #include <linux/skbuff.h>
  26 #include <linux/spinlock.h>
  27 #include <linux/u64_stats_sync.h>
  28
  29 struct vport;
  30 struct vport_parms;
  31
  32 /* The following definitions are for users of the vport subsytem: */
  33
  34 int ovs_vport_init(void);
  35 void ovs_vport_exit(void);
  36
  37 struct vport *ovs_vport_add(const struct vport_parms *);
  38 void ovs_vport_del(struct vport *);
  39
  40 struct vport *ovs_vport_locate(struct net *net, const char *name);
  41
  42 void ovs_vport_set_stats(struct vport *, struct ovs_vport_stats *);
  43 void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *);
  44
  45 int ovs_vport_set_options(struct vport *, struct nlattr *options);
  46 int ovs_vport_get_options(const struct vport *, struct sk_buff *);
  47
  48 int ovs_vport_send(struct vport *, struct sk_buff *);
  49
  50 /* The following definitions are for implementers of vport devices: */
  51
  52 struct vport_percpu_stats {
  53         u64 rx_bytes;
  54         u64 rx_packets;
  55         u64 tx_bytes;
  56         u64 tx_packets;
  57         struct u64_stats_sync sync;
  58 };
  59
  60 struct vport_err_stats {
  61         u64 rx_dropped;
  62         u64 rx_errors;
  63         u64 tx_dropped;
  64         u64 tx_errors;
  65 };
  66
  67 /**
  68  * struct vport - one port within a datapath
  69  * @rcu: RCU callback head for deferred destruction.
  70  * @dp: Datapath to which this port belongs.
  71  * @linkname: The name of the link from /sys/class/net/<datapath>/brif to this
  72  * &struct vport.  (We keep this around so that we can delete it if the
  73  * device gets renamed.)  Set to the null string when no link exists.
  74  * @upcall_portid: The Netlink port to use for packets received on this port that
  75  * miss the flow table.
  76  * @port_no: Index into @dp's @ports array.
  77  * @hash_node: Element in @dev_table hash table in vport.c.
  78  * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
  79  * @ops: Class structure.
  80  * @percpu_stats: Points to per-CPU statistics used and maintained by vport
  81  * @stats_lock: Protects @err_stats and @offset_stats.
  82  * @err_stats: Points to error statistics used and maintained by vport
  83  * @offset_stats: Added to actual statistics as a sop to compatibility with
  84  * XAPI for Citrix XenServer.  Deprecated.
  85  */
  86 struct vport {
  87         struct rcu_head rcu;
  88         struct datapath *dp;
  89         char linkname[IFNAMSIZ];
  90         u32 upcall_portid;
  91         u16 port_no;
  92
  93         struct hlist_node hash_node;
  94         struct hlist_node dp_hash_node;
  95         const struct vport_ops *ops;
  96
  97         struct vport_percpu_stats __percpu *percpu_stats;
  98
  99         spinlock_t stats_lock;
 100         struct vport_err_stats err_stats;
 101         struct ovs_vport_stats offset_stats;
 102 };
 103
 104 #define VPORT_F_REQUIRED        (1 << 0) /* If init fails, module loading fails. */
 105 #define VPORT_F_FLOW            (1 << 1) /* Sets OVS_CB(skb)->flow. */
 106 #define VPORT_F_TUN_ID          (1 << 2) /* Sets OVS_CB(skb)->tun_id. */
 107
 108 /**
 109  * struct vport_parms - parameters for creating a new vport
 110  *
 111  * @name: New vport's name.
 112  * @type: New vport's type.
 113  * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
 114  * none was supplied.
 115  * @dp: New vport's datapath.
 116  * @port_no: New vport's port number.
 117  */
 118 struct vport_parms {
 119         const char *name;
 120         enum ovs_vport_type type;
 121         struct nlattr *options;
 122
 123         /* For ovs_vport_alloc(). */
 124         struct datapath *dp;
 125         u16 port_no;
 126         u32 upcall_portid;
 127 };
 128
 129 /**
 130  * struct vport_ops - definition of a type of virtual port
 131  *
 132  * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
 133  * @flags: Flags of type VPORT_F_* that influence how the generic vport layer
 134  * handles this vport.
 135  * @init: Called at module initialization.  If VPORT_F_REQUIRED is set then the
 136  * failure of this function will cause the module to not load.  If the flag is
 137  * not set and initialzation fails then no vports of this type can be created.
 138  * @exit: Called at module unload.
 139  * @create: Create a new vport configured as specified.  On success returns
 140  * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
 141  * @destroy: Destroys a vport.  Must call vport_free() on the vport but not
 142  * before an RCU grace period has elapsed.
 143  * @set_options: Modify the configuration of an existing vport.  May be %NULL
 144  * if modification is not supported.
 145  * @get_options: Appends vport-specific attributes for the configuration of an
 146  * existing vport to a &struct sk_buff.  May be %NULL for a vport that does not
 147  * have any configuration.
 148  * @get_name: Get the device's name.
 149  * @get_config: Get the device's configuration.
 150  * @get_ifindex: Get the system interface index associated with the device.
 151  * May be null if the device does not have an ifindex.
 152  * @send: Send a packet on the device.  Returns the length of the packet sent.
 153  */
 154 struct vport_ops {
 155         enum ovs_vport_type type;
 156         u32 flags;
 157
 158         /* Called at module init and exit respectively. */
 159         int (*init)(void);
 160         void (*exit)(void);
 161
 162         /* Called with RTNL lock. */
 163         struct vport *(*create)(const struct vport_parms *);
 164         void (*destroy)(struct vport *);
 165
 166         int (*set_options)(struct vport *, struct nlattr *);
 167         int (*get_options)(const struct vport *, struct sk_buff *);
 168
 169         /* Called with rcu_read_lock or RTNL lock. */
 170         const char *(*get_name)(const struct vport *);
 171         void (*get_config)(const struct vport *, void *);
 172         int (*get_ifindex)(const struct vport *);
 173         int (*send)(struct vport *, struct sk_buff *);
 174 };
 175
 176 enum vport_err_type {
 177         VPORT_E_RX_DROPPED,
 178         VPORT_E_RX_ERROR,
 179         VPORT_E_TX_DROPPED,
 180         VPORT_E_TX_ERROR,
 181 };
 182
 183 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
 184                               const struct vport_parms *);
 185 void ovs_vport_free(struct vport *);
 186
 187 #define VPORT_ALIGN 8
 188
 189 /**
 190  *      vport_priv - access private data area of vport
 191  *
 192  * @vport: vport to access
 193  *
 194  * If a nonzero size was passed in priv_size of vport_alloc() a private data
 195  * area was allocated on creation.  This allows that area to be accessed and
 196  * used for any purpose needed by the vport implementer.
 197  */
 198 static inline void *vport_priv(const struct vport *vport)
 199 {
 200         return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
 201 }
 202
 203 /**
 204  *      vport_from_priv - lookup vport from private data pointer
 205  *
 206  * @priv: Start of private data area.
 207  *
 208  * It is sometimes useful to translate from a pointer to the private data
 209  * area to the vport, such as in the case where the private data pointer is
 210  * the result of a hash table lookup.  @priv must point to the start of the
 211  * private data area.
 212  */
 213 static inline struct vport *vport_from_priv(const void *priv)
 214 {
 215         return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
 216 }
 217
 218 void ovs_vport_receive(struct vport *, struct sk_buff *);
 219 void ovs_vport_record_error(struct vport *, enum vport_err_type err_type);
 220
 221 /* List of statically compiled vport implementations.  Don't forget to also
 222  * add yours to the list at the top of vport.c. */
 223 extern const struct vport_ops ovs_netdev_vport_ops;
 224 extern const struct vport_ops ovs_internal_vport_ops;
 225 extern const struct vport_ops ovs_gre_vport_ops;
 226 extern const struct vport_ops ovs_gre64_vport_ops;
 227 extern const struct vport_ops ovs_vxlan_vport_ops;
 228
 229 #endif /* vport.h */