blob: 3f7961ea3c568d54011d6a570975fceb3c20d15f [file] [log] [blame]
Jesse Grossccb13522011-10-25 19:26:31 -07001/*
Raju Subramaniancaf2ee12012-05-03 18:55:23 -07002 * Copyright (c) 2007-2012 Nicira, Inc.
Jesse Grossccb13522011-10-25 19:26:31 -07003 *
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>
Pravin B Shelar46df7b82012-02-22 19:58:59 -080023#include <linux/netlink.h>
Jesse Grossccb13522011-10-25 19:26:31 -070024#include <linux/openvswitch.h>
25#include <linux/skbuff.h>
26#include <linux/spinlock.h>
27#include <linux/u64_stats_sync.h>
28
29#include "datapath.h"
30
31struct vport;
32struct vport_parms;
33
34/* The following definitions are for users of the vport subsytem: */
35
36int ovs_vport_init(void);
37void ovs_vport_exit(void);
38
39struct vport *ovs_vport_add(const struct vport_parms *);
40void ovs_vport_del(struct vport *);
41
Pravin B Shelar46df7b82012-02-22 19:58:59 -080042struct vport *ovs_vport_locate(struct net *net, const char *name);
Jesse Grossccb13522011-10-25 19:26:31 -070043
44void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *);
45
46int ovs_vport_set_options(struct vport *, struct nlattr *options);
47int ovs_vport_get_options(const struct vport *, struct sk_buff *);
48
49int ovs_vport_send(struct vport *, struct sk_buff *);
50
51/* The following definitions are for implementers of vport devices: */
52
53struct vport_percpu_stats {
54 u64 rx_bytes;
55 u64 rx_packets;
56 u64 tx_bytes;
57 u64 tx_packets;
58 struct u64_stats_sync sync;
59};
60
61struct vport_err_stats {
62 u64 rx_dropped;
63 u64 rx_errors;
64 u64 tx_dropped;
65 u64 tx_errors;
66};
67
68/**
69 * struct vport - one port within a datapath
70 * @rcu: RCU callback head for deferred destruction.
71 * @port_no: Index into @dp's @ports array.
72 * @dp: Datapath to which this port belongs.
Eric W. Biederman15e47302012-09-07 20:12:54 +000073 * @upcall_portid: The Netlink port to use for packets received on this port that
Jesse Grossccb13522011-10-25 19:26:31 -070074 * miss the flow table.
75 * @hash_node: Element in @dev_table hash table in vport.c.
Pravin B Shelar15eac2a2012-08-23 12:40:54 -070076 * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
Jesse Grossccb13522011-10-25 19:26:31 -070077 * @ops: Class structure.
78 * @percpu_stats: Points to per-CPU statistics used and maintained by vport
79 * @stats_lock: Protects @err_stats;
80 * @err_stats: Points to error statistics used and maintained by vport
81 */
82struct vport {
83 struct rcu_head rcu;
84 u16 port_no;
85 struct datapath *dp;
Eric W. Biederman15e47302012-09-07 20:12:54 +000086 u32 upcall_portid;
Jesse Grossccb13522011-10-25 19:26:31 -070087
88 struct hlist_node hash_node;
Pravin B Shelar15eac2a2012-08-23 12:40:54 -070089 struct hlist_node dp_hash_node;
Jesse Grossccb13522011-10-25 19:26:31 -070090 const struct vport_ops *ops;
91
92 struct vport_percpu_stats __percpu *percpu_stats;
93
94 spinlock_t stats_lock;
95 struct vport_err_stats err_stats;
96};
97
98/**
99 * struct vport_parms - parameters for creating a new vport
100 *
101 * @name: New vport's name.
102 * @type: New vport's type.
103 * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
104 * none was supplied.
105 * @dp: New vport's datapath.
106 * @port_no: New vport's port number.
107 */
108struct vport_parms {
109 const char *name;
110 enum ovs_vport_type type;
111 struct nlattr *options;
112
113 /* For ovs_vport_alloc(). */
114 struct datapath *dp;
115 u16 port_no;
Eric W. Biederman15e47302012-09-07 20:12:54 +0000116 u32 upcall_portid;
Jesse Grossccb13522011-10-25 19:26:31 -0700117};
118
119/**
120 * struct vport_ops - definition of a type of virtual port
121 *
122 * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
123 * @create: Create a new vport configured as specified. On success returns
124 * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
125 * @destroy: Destroys a vport. Must call vport_free() on the vport but not
126 * before an RCU grace period has elapsed.
127 * @set_options: Modify the configuration of an existing vport. May be %NULL
128 * if modification is not supported.
129 * @get_options: Appends vport-specific attributes for the configuration of an
130 * existing vport to a &struct sk_buff. May be %NULL for a vport that does not
131 * have any configuration.
132 * @get_name: Get the device's name.
133 * @get_config: Get the device's configuration.
134 * @get_ifindex: Get the system interface index associated with the device.
135 * May be null if the device does not have an ifindex.
136 * @send: Send a packet on the device. Returns the length of the packet sent.
137 */
138struct vport_ops {
139 enum ovs_vport_type type;
140
141 /* Called with RTNL lock. */
142 struct vport *(*create)(const struct vport_parms *);
143 void (*destroy)(struct vport *);
144
145 int (*set_options)(struct vport *, struct nlattr *);
146 int (*get_options)(const struct vport *, struct sk_buff *);
147
148 /* Called with rcu_read_lock or RTNL lock. */
149 const char *(*get_name)(const struct vport *);
150 void (*get_config)(const struct vport *, void *);
151 int (*get_ifindex)(const struct vport *);
152
153 int (*send)(struct vport *, struct sk_buff *);
154};
155
156enum vport_err_type {
157 VPORT_E_RX_DROPPED,
158 VPORT_E_RX_ERROR,
159 VPORT_E_TX_DROPPED,
160 VPORT_E_TX_ERROR,
161};
162
163struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
164 const struct vport_parms *);
165void ovs_vport_free(struct vport *);
166
167#define VPORT_ALIGN 8
168
169/**
170 * vport_priv - access private data area of vport
171 *
172 * @vport: vport to access
173 *
174 * If a nonzero size was passed in priv_size of vport_alloc() a private data
175 * area was allocated on creation. This allows that area to be accessed and
176 * used for any purpose needed by the vport implementer.
177 */
178static inline void *vport_priv(const struct vport *vport)
179{
180 return (u8 *)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
181}
182
183/**
184 * vport_from_priv - lookup vport from private data pointer
185 *
186 * @priv: Start of private data area.
187 *
188 * It is sometimes useful to translate from a pointer to the private data
189 * area to the vport, such as in the case where the private data pointer is
190 * the result of a hash table lookup. @priv must point to the start of the
191 * private data area.
192 */
193static inline struct vport *vport_from_priv(const void *priv)
194{
195 return (struct vport *)(priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
196}
197
198void ovs_vport_receive(struct vport *, struct sk_buff *);
199void ovs_vport_record_error(struct vport *, enum vport_err_type err_type);
200
201/* List of statically compiled vport implementations. Don't forget to also
202 * add yours to the list at the top of vport.c. */
203extern const struct vport_ops ovs_netdev_vport_ops;
204extern const struct vport_ops ovs_internal_vport_ops;
205
206#endif /* vport.h */