1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
4 * We are making the OpenFlow specification and associated documentation
5 * (Software) available for public use and benefit with the expectation
6 * that others will use, modify and enhance the Software and contribute
7 * those enhancements back to the community. However, since we would
8 * like to make the Software available for broadest use, with as few
9 * restrictions as possible permission is hereby granted, free of
10 * charge, to any person obtaining a copy of this Software to deal in
11 * the Software under the copyrights without restriction, including
12 * without limitation the rights to use, copy, modify, merge, publish,
13 * distribute, sublicense, and/or sell copies of the Software, and to
14 * permit persons to whom the Software is furnished to do so, subject to
15 * the following conditions:
17 * The above copyright notice and this permission notice shall be
18 * included in all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 * The name and trademarks of copyright holder(s) may NOT be used in
30 * advertising or publicity pertaining to the Software or any
31 * derivatives without specific, written prior permission.
44 /* Client interface. */
46 /* Virtual connection to an OpenFlow device. */
48 struct vconn_class *class;
52 int vconn_open(const char *name, struct vconn **);
53 void vconn_close(struct vconn *);
54 bool vconn_is_passive(const struct vconn *);
55 int vconn_connect(struct vconn *);
56 int vconn_accept(struct vconn *, struct vconn **);
57 int vconn_recv(struct vconn *, struct buffer **);
58 int vconn_send(struct vconn *, struct buffer *);
60 int vconn_open_block(const char *name, struct vconn **);
61 int vconn_send_block(struct vconn *, struct buffer *);
63 enum vconn_wait_type {
69 void vconn_wait(struct vconn *, enum vconn_wait_type);
70 void vconn_connect_wait(struct vconn *);
71 void vconn_accept_wait(struct vconn *);
72 void vconn_recv_wait(struct vconn *);
73 void vconn_send_wait(struct vconn *);
75 struct buffer *make_add_simple_flow(const struct flow *,
76 uint32_t buffer_id, uint16_t out_port);
77 struct buffer *make_buffered_packet_out(uint32_t buffer_id,
78 uint16_t in_port, uint16_t out_port);
79 struct buffer *make_unbuffered_packet_out(const struct buffer *packet,
80 uint16_t in_port, uint16_t out_port);
82 /* Provider interface. */
85 /* Prefix for connection names, e.g. "nl", "tcp". */
88 /* Attempts to connect to an OpenFlow device. 'name' is the full
89 * connection name provided by the user, e.g. "nl:0", "tcp:1.2.3.4". This
90 * name is useful for error messages but must not be modified.
92 * 'suffix' is a copy of 'name' following the colon and may be modified.
94 * Returns 0 if successful, otherwise a positive errno value. If
95 * successful, stores a pointer to the new connection in '*vconnp'.
97 * The open function must not block waiting for a connection to complete.
98 * If the connection cannot be completed immediately, it should return
99 * EAGAIN (not EINPROGRESS, as returned by the connect system call) and
100 * continue the connection in the background. */
101 int (*open)(const char *name, char *suffix, struct vconn **vconnp);
103 /* Closes 'vconn' and frees associated memory. */
104 void (*close)(struct vconn *vconn);
106 /* Tries to complete the connection on 'vconn', which must be an active
107 * vconn. If 'vconn''s connection is complete, returns 0 if the connection
108 * was successful or a positive errno value if it failed. If the
109 * connection is still in progress, returns EAGAIN.
111 * The connect function must not block waiting for the connection to
112 * complete; instead, it should return EAGAIN immediately. */
113 int (*connect)(struct vconn *vconn);
115 /* Tries to accept a new connection on 'vconn', which must be a passive
116 * vconn. If successful, stores the new connection in '*new_vconnp' and
117 * returns 0. Otherwise, returns a positive errno value.
119 * The accept function must not block waiting for a connection. If no
120 * connection is ready to be accepted, it should return EAGAIN.
122 * Nonnull iff this is a passive vconn (one that accepts connections and
123 * does not transfer data). */
124 int (*accept)(struct vconn *vconn, struct vconn **new_vconnp);
126 /* Tries to receive an OpenFlow message from 'vconn', which must be an
127 * active vconn. If successful, stores the received message into '*msgp'
128 * and returns 0. The caller is responsible for destroying the message
129 * with buffer_delete(). On failure, returns a positive errno value and
130 * stores a null pointer into '*msgp'.
132 * If the connection has been closed in the normal fashion, returns EOF.
134 * The recv function must not block waiting for a packet to arrive. If no
135 * packets have been received, it should return EAGAIN.
137 * Nonnull iff this is an active vconn (one that transfers data and does
138 * not accept connections). */
139 int (*recv)(struct vconn *vconn, struct buffer **msgp);
141 /* Tries to queue 'msg' for transmission on 'vconn', which must be an
142 * active vconn. If successful, returns 0, in which case ownership of
143 * 'msg' is transferred to the vconn. Success does not guarantee that
144 * 'msg' has been or ever will be delivered to the peer, only that it has
145 * been queued for transmission.
147 * Returns a positive errno value on failure, in which case the caller
148 * retains ownership of 'msg'.
150 * The send function must not block. If 'msg' cannot be immediately
151 * accepted for transmission, it should return EAGAIN.
153 * Nonnull iff this is an active vconn (one that transfers data and does
154 * not accept connections). */
155 int (*send)(struct vconn *vconn, struct buffer *msg);
157 void (*wait)(struct vconn *vconn, enum vconn_wait_type);
160 extern struct vconn_class tcp_vconn_class;
161 extern struct vconn_class ptcp_vconn_class;
163 extern struct vconn_class ssl_vconn_class;
164 extern struct vconn_class pssl_vconn_class;
167 extern struct vconn_class netlink_vconn_class;