lib: Utilize smaps in the idl.
[openvswitch] / lib / vconn-provider.h
1 /*
2  * Copyright (c) 2008, 2009, 2010 Nicira, Inc.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #ifndef VCONN_PROVIDER_H
18 #define VCONN_PROVIDER_H 1
19
20 /* Provider interface to vconns, which provide a virtual connection to an
21  * OpenFlow device. */
22
23 #include <assert.h>
24 #include "vconn.h"
25 \f
26 /* Active virtual connection to an OpenFlow device. */
27
28 /* Active virtual connection to an OpenFlow device.
29  *
30  * This structure should be treated as opaque by vconn implementations. */
31 struct vconn {
32     struct vconn_class *class;
33     int state;
34     int error;
35     int min_version;
36     int version;
37     ovs_be32 remote_ip;
38     ovs_be16 remote_port;
39     ovs_be32 local_ip;
40     ovs_be16 local_port;
41     char *name;
42 };
43
44 void vconn_init(struct vconn *, struct vconn_class *, int connect_status,
45                 const char *name);
46 void vconn_set_remote_ip(struct vconn *, ovs_be32 remote_ip);
47 void vconn_set_remote_port(struct vconn *, ovs_be16 remote_port);
48 void vconn_set_local_ip(struct vconn *, ovs_be32 local_ip);
49 void vconn_set_local_port(struct vconn *, ovs_be16 local_port);
50 static inline void vconn_assert_class(const struct vconn *vconn,
51                                       const struct vconn_class *class)
52 {
53     assert(vconn->class == class);
54 }
55
56 struct vconn_class {
57     /* Prefix for connection names, e.g. "nl", "tcp". */
58     const char *name;
59
60     /* Attempts to connect to an OpenFlow device.  'name' is the full
61      * connection name provided by the user, e.g. "tcp:1.2.3.4".  This name is
62      * useful for error messages but must not be modified.
63      *
64      * 'suffix' is a copy of 'name' following the colon and may be modified.
65      * 'dscp' is the DSCP value that the new connection should use in the IP
66      * packets it sends.
67      *
68      * Returns 0 if successful, otherwise a positive errno value.  If
69      * successful, stores a pointer to the new connection in '*vconnp'.
70      *
71      * The open function must not block waiting for a connection to complete.
72      * If the connection cannot be completed immediately, it should return
73      * EAGAIN (not EINPROGRESS, as returned by the connect system call) and
74      * continue the connection in the background. */
75     int (*open)(const char *name, char *suffix, struct vconn **vconnp,
76                 uint8_t dscp);
77
78     /* Closes 'vconn' and frees associated memory. */
79     void (*close)(struct vconn *vconn);
80
81     /* Tries to complete the connection on 'vconn'.  If 'vconn''s connection is
82      * complete, returns 0 if the connection was successful or a positive errno
83      * value if it failed.  If the connection is still in progress, returns
84      * EAGAIN.
85      *
86      * The connect function must not block waiting for the connection to
87      * complete; instead, it should return EAGAIN immediately. */
88     int (*connect)(struct vconn *vconn);
89
90     /* Tries to receive an OpenFlow message from 'vconn'.  If successful,
91      * stores the received message into '*msgp' and returns 0.  The caller is
92      * responsible for destroying the message with ofpbuf_delete().  On
93      * failure, returns a positive errno value and stores a null pointer into
94      * '*msgp'.
95      *
96      * If the connection has been closed in the normal fashion, returns EOF.
97      *
98      * The recv function must not block waiting for a packet to arrive.  If no
99      * packets have been received, it should return EAGAIN. */
100     int (*recv)(struct vconn *vconn, struct ofpbuf **msgp);
101
102     /* Tries to queue 'msg' for transmission on 'vconn'.  If successful,
103      * returns 0, in which case ownership of 'msg' is transferred to the vconn.
104      * Success does not guarantee that 'msg' has been or ever will be delivered
105      * to the peer, only that it has been queued for transmission.
106      *
107      * Returns a positive errno value on failure, in which case the caller
108      * retains ownership of 'msg'.
109      *
110      * The send function must not block.  If 'msg' cannot be immediately
111      * accepted for transmission, it should return EAGAIN. */
112     int (*send)(struct vconn *vconn, struct ofpbuf *msg);
113
114     /* Allows 'vconn' to perform maintenance activities, such as flushing
115      * output buffers.
116      *
117      * May be null if 'vconn' doesn't have anything to do here. */
118     void (*run)(struct vconn *vconn);
119
120     /* Arranges for the poll loop to wake up when 'vconn' needs to perform
121      * maintenance activities.
122      *
123      * May be null if 'vconn' doesn't have anything to do here. */
124     void (*run_wait)(struct vconn *vconn);
125
126     /* Arranges for the poll loop to wake up when 'vconn' is ready to take an
127      * action of the given 'type'. */
128     void (*wait)(struct vconn *vconn, enum vconn_wait_type type);
129 };
130 \f
131 /* Passive virtual connection to an OpenFlow device.
132  *
133  * This structure should be treated as opaque by vconn implementations. */
134 struct pvconn {
135     struct pvconn_class *class;
136     char *name;
137 };
138
139 void pvconn_init(struct pvconn *, struct pvconn_class *, const char *name);
140 static inline void pvconn_assert_class(const struct pvconn *pvconn,
141                                        const struct pvconn_class *class)
142 {
143     assert(pvconn->class == class);
144 }
145
146 struct pvconn_class {
147     /* Prefix for connection names, e.g. "ptcp", "pssl". */
148     const char *name;
149
150     /* Attempts to start listening for OpenFlow connections.  'name' is the
151      * full connection name provided by the user, e.g. "ptcp:1234".  This name
152      * is useful for error messages but must not be modified.
153      *
154      * 'suffix' is a copy of 'name' following the colon and may be modified.
155      * 'dscp' is the DSCP value that the new connection should use in the IP
156      * packets it sends.
157      *
158      * Returns 0 if successful, otherwise a positive errno value.  If
159      * successful, stores a pointer to the new connection in '*pvconnp'.
160      *
161      * The listen function must not block.  If the connection cannot be
162      * completed immediately, it should return EAGAIN (not EINPROGRESS, as
163      * returned by the connect system call) and continue the connection in the
164      * background. */
165     int (*listen)(const char *name, char *suffix, struct pvconn **pvconnp,
166                   uint8_t dscp);
167
168     /* Closes 'pvconn' and frees associated memory. */
169     void (*close)(struct pvconn *pvconn);
170
171     /* Tries to accept a new connection on 'pvconn'.  If successful, stores the
172      * new connection in '*new_vconnp' and returns 0.  Otherwise, returns a
173      * positive errno value.
174      *
175      * The accept function must not block waiting for a connection.  If no
176      * connection is ready to be accepted, it should return EAGAIN. */
177     int (*accept)(struct pvconn *pvconn, struct vconn **new_vconnp);
178
179     /* Arranges for the poll loop to wake up when a connection is ready to be
180      * accepted on 'pvconn'. */
181     void (*wait)(struct pvconn *pvconn);
182 };
183
184 /* Active and passive vconn classes. */
185 extern struct vconn_class tcp_vconn_class;
186 extern struct pvconn_class ptcp_pvconn_class;
187 extern struct vconn_class unix_vconn_class;
188 extern struct pvconn_class punix_pvconn_class;
189 #ifdef HAVE_OPENSSL
190 extern struct vconn_class ssl_vconn_class;
191 extern struct pvconn_class pssl_pvconn_class;
192 #endif
193
194 #endif /* vconn-provider.h */