forked from openvswitch/ovs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathvconn-provider.h
198 lines (172 loc) · 7.96 KB
/
vconn-provider.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
/*
* Copyright (c) 2008, 2009, 2010, 2012, 2013, 2015 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef VCONN_PROVIDER_H
#define VCONN_PROVIDER_H 1
/* Provider interface to vconns, which provide a virtual connection to an
* OpenFlow device. */
#include "openvswitch/vconn.h"
#include "util.h"
#include "openflow/openflow-common.h"
/* Active virtual connection to an OpenFlow device. */
/* This structure should be treated as opaque by vconn implementations. */
struct vconn {
const struct vconn_class *vclass;
int state;
int error;
/* OpenFlow versions. */
uint32_t allowed_versions; /* Bitmap of versions we will accept. */
uint32_t peer_versions; /* Peer's bitmap of versions it will accept. */
enum ofp_version version; /* Negotiated version (or 0). */
bool recv_any_version; /* True to receive a message of any version. */
char *name;
};
void vconn_init(struct vconn *, const struct vconn_class *, int connect_status,
const char *name, uint32_t allowed_versions);
void vconn_free_data(struct vconn *vconn);
static inline void vconn_assert_class(const struct vconn *vconn,
const struct vconn_class *vclass)
{
ovs_assert(vconn->vclass == vclass);
}
struct vconn_class {
/* Prefix for connection names, e.g. "nl", "tcp". */
const char *name;
/* Attempts to connect to an OpenFlow device. 'name' is the full
* connection name provided by the user, e.g. "tcp:1.2.3.4". This name is
* useful for error messages but must not be modified.
*
* 'allowed_versions' is the OpenFlow versions that may be
* negotiated for a connection.
*
* 'suffix' is a copy of 'name' following the colon and may be modified.
* 'dscp' is the DSCP value that the new connection should use in the IP
* packets it sends.
*
* Returns 0 if successful, otherwise a positive errno value. If
* successful, stores a pointer to the new connection in '*vconnp'.
*
* The open function must not block waiting for a connection to complete.
* If the connection cannot be completed immediately, it should return
* EAGAIN (not EINPROGRESS, as returned by the connect system call) and
* continue the connection in the background. */
int (*open)(const char *name, uint32_t allowed_versions,
char *suffix, struct vconn **vconnp, uint8_t dscp);
/* Closes 'vconn' and frees associated memory. */
void (*close)(struct vconn *vconn);
/* Tries to complete the connection on 'vconn'. If 'vconn''s connection is
* complete, returns 0 if the connection was successful or a positive errno
* value if it failed. If the connection is still in progress, returns
* EAGAIN.
*
* The connect function must not block waiting for the connection to
* complete; instead, it should return EAGAIN immediately. */
int (*connect)(struct vconn *vconn);
/* Tries to receive an OpenFlow message from 'vconn'. If successful,
* stores the received message into '*msgp' and returns 0. The caller is
* responsible for destroying the message with ofpbuf_delete(). On
* failure, returns a positive errno value and stores a null pointer into
* '*msgp'.
*
* If the connection has been closed in the normal fashion, returns EOF.
*
* The recv function must not block waiting for a packet to arrive. If no
* packets have been received, it should return EAGAIN. */
int (*recv)(struct vconn *vconn, struct ofpbuf **msgp);
/* Tries to queue 'msg' for transmission on 'vconn'. If successful,
* returns 0, in which case ownership of 'msg' is transferred to the vconn.
* Success does not guarantee that 'msg' has been or ever will be delivered
* to the peer, only that it has been queued for transmission.
*
* Returns a positive errno value on failure, in which case the caller
* retains ownership of 'msg'.
*
* The send function must not block. If 'msg' cannot be immediately
* accepted for transmission, it should return EAGAIN. */
int (*send)(struct vconn *vconn, struct ofpbuf *msg);
/* Allows 'vconn' to perform maintenance activities, such as flushing
* output buffers.
*
* May be null if 'vconn' doesn't have anything to do here. */
void (*run)(struct vconn *vconn);
/* Arranges for the poll loop to wake up when 'vconn' needs to perform
* maintenance activities.
*
* May be null if 'vconn' doesn't have anything to do here. */
void (*run_wait)(struct vconn *vconn);
/* Arranges for the poll loop to wake up when 'vconn' is ready to take an
* action of the given 'type'. */
void (*wait)(struct vconn *vconn, enum vconn_wait_type type);
};
/* Passive virtual connection to an OpenFlow device. */
/* This structure should be treated as opaque by vconn implementations. */
struct pvconn {
const struct pvconn_class *pvclass;
char *name;
uint32_t allowed_versions;
};
void pvconn_init(struct pvconn *pvconn, const struct pvconn_class *pvclass,
const char *name, uint32_t allowed_versions);
static inline void pvconn_assert_class(const struct pvconn *pvconn,
const struct pvconn_class *pvclass)
{
ovs_assert(pvconn->pvclass == pvclass);
}
struct pvconn_class {
/* Prefix for connection names, e.g. "ptcp", "pssl". */
const char *name;
/* Attempts to start listening for OpenFlow connections. 'name' is the
* full connection name provided by the user, e.g. "ptcp:1234". This name
* is useful for error messages but must not be modified.
*
* 'allowed_versions' is the OpenFlow protocol versions that may
* be negotiated for a session.
*
* 'suffix' is a copy of 'name' following the colon and may be modified.
* 'dscp' is the DSCP value that the new connection should use in the IP
* packets it sends.
*
* Returns 0 if successful, otherwise a positive errno value. If
* successful, stores a pointer to the new connection in '*pvconnp'.
*
* The listen function must not block. If the connection cannot be
* completed immediately, it should return EAGAIN (not EINPROGRESS, as
* returned by the connect system call) and continue the connection in the
* background. */
int (*listen)(const char *name, uint32_t allowed_versions,
char *suffix, struct pvconn **pvconnp, uint8_t dscp);
/* Closes 'pvconn' and frees associated memory. */
void (*close)(struct pvconn *pvconn);
/* Tries to accept a new connection on 'pvconn'. If successful, stores the
* new connection in '*new_vconnp' and returns 0. Otherwise, returns a
* positive errno value.
*
* The accept function must not block waiting for a connection. If no
* connection is ready to be accepted, it should return EAGAIN. */
int (*accept)(struct pvconn *pvconn, struct vconn **new_vconnp);
/* Arranges for the poll loop to wake up when a connection is ready to be
* accepted on 'pvconn'. */
void (*wait)(struct pvconn *pvconn);
};
/* Active and passive vconn classes. */
extern const struct vconn_class tcp_vconn_class;
extern const struct pvconn_class ptcp_pvconn_class;
extern const struct vconn_class unix_vconn_class;
extern const struct pvconn_class punix_pvconn_class;
#ifdef HAVE_OPENSSL
extern const struct vconn_class ssl_vconn_class;
extern const struct pvconn_class pssl_pvconn_class;
#endif
#endif /* vconn-provider.h */