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.
45 /* Client interface. */
47 /* Virtual connection to an OpenFlow device. */
49 struct vconn_class *class;
54 void vconn_usage(bool active, bool passive);
55 int vconn_open(const char *name, struct vconn **);
56 void vconn_close(struct vconn *);
57 bool vconn_is_passive(const struct vconn *);
58 uint32_t vconn_get_ip(const struct vconn *);
59 int vconn_connect(struct vconn *);
60 int vconn_accept(struct vconn *, struct vconn **);
61 int vconn_recv(struct vconn *, struct buffer **);
62 int vconn_send(struct vconn *, struct buffer *);
64 int vconn_open_block(const char *name, struct vconn **);
65 int vconn_send_block(struct vconn *, struct buffer *);
66 int vconn_recv_block(struct vconn *, struct buffer **);
68 enum vconn_wait_type {
74 void vconn_wait(struct vconn *, enum vconn_wait_type);
75 void vconn_connect_wait(struct vconn *);
76 void vconn_accept_wait(struct vconn *);
77 void vconn_recv_wait(struct vconn *);
78 void vconn_send_wait(struct vconn *);
80 struct buffer *make_add_simple_flow(const struct flow *,
81 uint32_t buffer_id, uint16_t out_port,
83 struct buffer *make_buffered_packet_out(uint32_t buffer_id,
84 uint16_t in_port, uint16_t out_port);
85 struct buffer *make_unbuffered_packet_out(const struct buffer *packet,
86 uint16_t in_port, uint16_t out_port);
87 struct buffer *make_echo_request(void);
88 struct buffer *make_echo_reply(const struct ofp_header *rq);
90 /* Provider interface. */
93 /* Prefix for connection names, e.g. "nl", "tcp". */
96 /* Attempts to connect to an OpenFlow device. 'name' is the full
97 * connection name provided by the user, e.g. "nl:0", "tcp:1.2.3.4". This
98 * name is useful for error messages but must not be modified.
100 * 'suffix' is a copy of 'name' following the colon and may be modified.
102 * Returns 0 if successful, otherwise a positive errno value. If
103 * successful, stores a pointer to the new connection in '*vconnp'.
105 * The open function must not block waiting for a connection to complete.
106 * If the connection cannot be completed immediately, it should return
107 * EAGAIN (not EINPROGRESS, as returned by the connect system call) and
108 * continue the connection in the background. */
109 int (*open)(const char *name, char *suffix, struct vconn **vconnp);
111 /* Closes 'vconn' and frees associated memory. */
112 void (*close)(struct vconn *vconn);
114 /* Tries to complete the connection on 'vconn', which must be an active
115 * vconn. If 'vconn''s connection is complete, returns 0 if the connection
116 * was successful or a positive errno value if it failed. If the
117 * connection is still in progress, returns EAGAIN.
119 * The connect function must not block waiting for the connection to
120 * complete; instead, it should return EAGAIN immediately. */
121 int (*connect)(struct vconn *vconn);
123 /* Tries to accept a new connection on 'vconn', which must be a passive
124 * vconn. If successful, stores the new connection in '*new_vconnp' and
125 * returns 0. Otherwise, returns a positive errno value.
127 * The accept function must not block waiting for a connection. If no
128 * connection is ready to be accepted, it should return EAGAIN.
130 * Nonnull iff this is a passive vconn (one that accepts connections and
131 * does not transfer data). */
132 int (*accept)(struct vconn *vconn, struct vconn **new_vconnp);
134 /* Tries to receive an OpenFlow message from 'vconn', which must be an
135 * active vconn. If successful, stores the received message into '*msgp'
136 * and returns 0. The caller is responsible for destroying the message
137 * with buffer_delete(). On failure, returns a positive errno value and
138 * stores a null pointer into '*msgp'.
140 * If the connection has been closed in the normal fashion, returns EOF.
142 * The recv function must not block waiting for a packet to arrive. If no
143 * packets have been received, it should return EAGAIN.
145 * Nonnull iff this is an active vconn (one that transfers data and does
146 * not accept connections). */
147 int (*recv)(struct vconn *vconn, struct buffer **msgp);
149 /* Tries to queue 'msg' for transmission on 'vconn', which must be an
150 * active vconn. If successful, returns 0, in which case ownership of
151 * 'msg' is transferred to the vconn. Success does not guarantee that
152 * 'msg' has been or ever will be delivered to the peer, only that it has
153 * been queued for transmission.
155 * Returns a positive errno value on failure, in which case the caller
156 * retains ownership of 'msg'.
158 * The send function must not block. If 'msg' cannot be immediately
159 * accepted for transmission, it should return EAGAIN.
161 * Nonnull iff this is an active vconn (one that transfers data and does
162 * not accept connections). */
163 int (*send)(struct vconn *vconn, struct buffer *msg);
165 void (*wait)(struct vconn *vconn, enum vconn_wait_type);
168 extern struct vconn_class tcp_vconn_class;
169 extern struct vconn_class ptcp_vconn_class;
171 extern struct vconn_class ssl_vconn_class;
172 extern struct vconn_class pssl_vconn_class;
175 extern struct vconn_class netlink_vconn_class;