2 * Copyright (c) 2008, 2009, 2010 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #ifndef VCONN_PROVIDER_H
18 #define VCONN_PROVIDER_H 1
20 /* Provider interface to vconns, which provide a virtual connection to an
25 #include "openflow/openflow-common.h"
27 /* Active virtual connection to an OpenFlow device. */
29 /* Active virtual connection to an OpenFlow device.
31 * This structure should be treated as opaque by vconn implementations. */
33 struct vconn_class *class;
36 enum ofp_version min_version;
37 enum ofp_version version;
45 void vconn_init(struct vconn *, struct vconn_class *, int connect_status,
47 void vconn_set_remote_ip(struct vconn *, ovs_be32 remote_ip);
48 void vconn_set_remote_port(struct vconn *, ovs_be16 remote_port);
49 void vconn_set_local_ip(struct vconn *, ovs_be32 local_ip);
50 void vconn_set_local_port(struct vconn *, ovs_be16 local_port);
51 static inline void vconn_assert_class(const struct vconn *vconn,
52 const struct vconn_class *class)
54 assert(vconn->class == class);
58 /* Prefix for connection names, e.g. "nl", "tcp". */
61 /* Attempts to connect to an OpenFlow device. 'name' is the full
62 * connection name provided by the user, e.g. "tcp:1.2.3.4". This name is
63 * useful for error messages but must not be modified.
65 * 'suffix' is a copy of 'name' following the colon and may be modified.
66 * 'dscp' is the DSCP value that the new connection should use in the IP
69 * Returns 0 if successful, otherwise a positive errno value. If
70 * successful, stores a pointer to the new connection in '*vconnp'.
72 * The open function must not block waiting for a connection to complete.
73 * If the connection cannot be completed immediately, it should return
74 * EAGAIN (not EINPROGRESS, as returned by the connect system call) and
75 * continue the connection in the background. */
76 int (*open)(const char *name, char *suffix, struct vconn **vconnp,
79 /* Closes 'vconn' and frees associated memory. */
80 void (*close)(struct vconn *vconn);
82 /* Tries to complete the connection on 'vconn'. If 'vconn''s connection is
83 * complete, returns 0 if the connection was successful or a positive errno
84 * value if it failed. If the connection is still in progress, returns
87 * The connect function must not block waiting for the connection to
88 * complete; instead, it should return EAGAIN immediately. */
89 int (*connect)(struct vconn *vconn);
91 /* Tries to receive an OpenFlow message from 'vconn'. If successful,
92 * stores the received message into '*msgp' and returns 0. The caller is
93 * responsible for destroying the message with ofpbuf_delete(). On
94 * failure, returns a positive errno value and stores a null pointer into
97 * If the connection has been closed in the normal fashion, returns EOF.
99 * The recv function must not block waiting for a packet to arrive. If no
100 * packets have been received, it should return EAGAIN. */
101 int (*recv)(struct vconn *vconn, struct ofpbuf **msgp);
103 /* Tries to queue 'msg' for transmission on 'vconn'. If successful,
104 * returns 0, in which case ownership of 'msg' is transferred to the vconn.
105 * Success does not guarantee that 'msg' has been or ever will be delivered
106 * to the peer, only that it has been queued for transmission.
108 * Returns a positive errno value on failure, in which case the caller
109 * retains ownership of 'msg'.
111 * The send function must not block. If 'msg' cannot be immediately
112 * accepted for transmission, it should return EAGAIN. */
113 int (*send)(struct vconn *vconn, struct ofpbuf *msg);
115 /* Allows 'vconn' to perform maintenance activities, such as flushing
118 * May be null if 'vconn' doesn't have anything to do here. */
119 void (*run)(struct vconn *vconn);
121 /* Arranges for the poll loop to wake up when 'vconn' needs to perform
122 * maintenance activities.
124 * May be null if 'vconn' doesn't have anything to do here. */
125 void (*run_wait)(struct vconn *vconn);
127 /* Arranges for the poll loop to wake up when 'vconn' is ready to take an
128 * action of the given 'type'. */
129 void (*wait)(struct vconn *vconn, enum vconn_wait_type type);
132 /* Passive virtual connection to an OpenFlow device.
134 * This structure should be treated as opaque by vconn implementations. */
136 struct pvconn_class *class;
140 void pvconn_init(struct pvconn *, struct pvconn_class *, const char *name);
141 static inline void pvconn_assert_class(const struct pvconn *pvconn,
142 const struct pvconn_class *class)
144 assert(pvconn->class == class);
147 struct pvconn_class {
148 /* Prefix for connection names, e.g. "ptcp", "pssl". */
151 /* Attempts to start listening for OpenFlow connections. 'name' is the
152 * full connection name provided by the user, e.g. "ptcp:1234". This name
153 * is useful for error messages but must not be modified.
155 * 'suffix' is a copy of 'name' following the colon and may be modified.
156 * 'dscp' is the DSCP value that the new connection should use in the IP
159 * Returns 0 if successful, otherwise a positive errno value. If
160 * successful, stores a pointer to the new connection in '*pvconnp'.
162 * The listen function must not block. If the connection cannot be
163 * completed immediately, it should return EAGAIN (not EINPROGRESS, as
164 * returned by the connect system call) and continue the connection in the
166 int (*listen)(const char *name, char *suffix, struct pvconn **pvconnp,
169 /* Closes 'pvconn' and frees associated memory. */
170 void (*close)(struct pvconn *pvconn);
172 /* Tries to accept a new connection on 'pvconn'. If successful, stores the
173 * new connection in '*new_vconnp' and returns 0. Otherwise, returns a
174 * positive errno value.
176 * The accept function must not block waiting for a connection. If no
177 * connection is ready to be accepted, it should return EAGAIN. */
178 int (*accept)(struct pvconn *pvconn, struct vconn **new_vconnp);
180 /* Arranges for the poll loop to wake up when a connection is ready to be
181 * accepted on 'pvconn'. */
182 void (*wait)(struct pvconn *pvconn);
185 /* Active and passive vconn classes. */
186 extern struct vconn_class tcp_vconn_class;
187 extern struct pvconn_class ptcp_pvconn_class;
188 extern struct vconn_class unix_vconn_class;
189 extern struct pvconn_class punix_pvconn_class;
191 extern struct vconn_class ssl_vconn_class;
192 extern struct pvconn_class pssl_pvconn_class;
195 #endif /* vconn-provider.h */