include/vconn.h

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   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:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  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
  27  * SOFTWARE.
  28  *
  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.
  32  */
  33
  34 #ifndef VCONN_H
  35 #define VCONN_H 1
  36
  37 #include <stdbool.h>
  38 #include <stddef.h>
  39 #include <stdint.h>
  40
  41 struct buffer;
  42 struct flow;
  43 struct pollfd;
  44 struct ofp_header;
  45
  46 /* Client interface. */
  47
  48 /* Virtual connection to an OpenFlow device. */
  49 struct vconn {
  50     struct vconn_class *class;
  51     int connect_status;
  52     uint32_t ip;
  53 };
  54
  55 void vconn_usage(bool active, bool passive);
  56 int vconn_open(const char *name, struct vconn **);
  57 void vconn_close(struct vconn *);
  58 bool vconn_is_passive(const struct vconn *);
  59 uint32_t vconn_get_ip(const struct vconn *);
  60 int vconn_connect(struct vconn *);
  61 int vconn_accept(struct vconn *, struct vconn **);
  62 int vconn_recv(struct vconn *, struct buffer **);
  63 int vconn_send(struct vconn *, struct buffer *);
  64 int vconn_transact(struct vconn *, struct buffer *, struct buffer **);
  65
  66 int vconn_open_block(const char *name, struct vconn **);
  67 int vconn_send_block(struct vconn *, struct buffer *);
  68 int vconn_recv_block(struct vconn *, struct buffer **);
  69
  70 enum vconn_wait_type {
  71     WAIT_CONNECT,
  72     WAIT_ACCEPT,
  73     WAIT_RECV,
  74     WAIT_SEND
  75 };
  76 void vconn_wait(struct vconn *, enum vconn_wait_type);
  77 void vconn_connect_wait(struct vconn *);
  78 void vconn_accept_wait(struct vconn *);
  79 void vconn_recv_wait(struct vconn *);
  80 void vconn_send_wait(struct vconn *);
  81
  82 void *make_openflow(size_t openflow_len, uint8_t type, struct buffer **);
  83 void *make_openflow_xid(size_t openflow_len, uint8_t type,
  84                         uint32_t xid, struct buffer **);
  85 void update_openflow_length(struct buffer *);
  86 struct buffer *make_add_flow(const struct flow *, uint32_t buffer_id,
  87                              uint16_t max_idle, size_t n_actions);
  88 struct buffer *make_add_simple_flow(const struct flow *,
  89                                     uint32_t buffer_id, uint16_t out_port,
  90                                     uint16_t max_idle);
  91 struct buffer *make_buffered_packet_out(uint32_t buffer_id,
  92                                         uint16_t in_port, uint16_t out_port);
  93 struct buffer *make_unbuffered_packet_out(const struct buffer *packet,
  94                                           uint16_t in_port, uint16_t out_port);
  95 struct buffer *make_echo_request(void);
  96 struct buffer *make_echo_reply(const struct ofp_header *rq);
  97 \f
  98 /* Provider interface. */
  99
 100 struct vconn_class {
 101     /* Prefix for connection names, e.g. "nl", "tcp". */
 102     const char *name;
 103
 104     /* Attempts to connect to an OpenFlow device.  'name' is the full
 105      * connection name provided by the user, e.g. "nl:0", "tcp:1.2.3.4".  This
 106      * name is useful for error messages but must not be modified.
 107      *
 108      * 'suffix' is a copy of 'name' following the colon and may be modified.
 109      *
 110      * Returns 0 if successful, otherwise a positive errno value.  If
 111      * successful, stores a pointer to the new connection in '*vconnp'.
 112      *
 113      * The open function must not block waiting for a connection to complete.
 114      * If the connection cannot be completed immediately, it should return
 115      * EAGAIN (not EINPROGRESS, as returned by the connect system call) and
 116      * continue the connection in the background. */
 117     int (*open)(const char *name, char *suffix, struct vconn **vconnp);
 118
 119     /* Closes 'vconn' and frees associated memory. */
 120     void (*close)(struct vconn *vconn);
 121
 122     /* Tries to complete the connection on 'vconn', which must be an active
 123      * vconn.  If 'vconn''s connection is complete, returns 0 if the connection
 124      * was successful or a positive errno value if it failed.  If the
 125      * connection is still in progress, returns EAGAIN.
 126      *
 127      * The connect function must not block waiting for the connection to
 128      * complete; instead, it should return EAGAIN immediately. */
 129     int (*connect)(struct vconn *vconn);
 130
 131     /* Tries to accept a new connection on 'vconn', which must be a passive
 132      * vconn.  If successful, stores the new connection in '*new_vconnp' and
 133      * returns 0.  Otherwise, returns a positive errno value.
 134      *
 135      * The accept function must not block waiting for a connection.  If no
 136      * connection is ready to be accepted, it should return EAGAIN.
 137      *
 138      * Nonnull iff this is a passive vconn (one that accepts connections and
 139      * does not transfer data). */
 140     int (*accept)(struct vconn *vconn, struct vconn **new_vconnp);
 141
 142     /* Tries to receive an OpenFlow message from 'vconn', which must be an
 143      * active vconn.  If successful, stores the received message into '*msgp'
 144      * and returns 0.  The caller is responsible for destroying the message
 145      * with buffer_delete().  On failure, returns a positive errno value and
 146      * stores a null pointer into '*msgp'.
 147      *
 148      * If the connection has been closed in the normal fashion, returns EOF.
 149      *
 150      * The recv function must not block waiting for a packet to arrive.  If no
 151      * packets have been received, it should return EAGAIN.
 152      *
 153      * Nonnull iff this is an active vconn (one that transfers data and does
 154      * not accept connections). */
 155     int (*recv)(struct vconn *vconn, struct buffer **msgp);
 156
 157     /* Tries to queue 'msg' for transmission on 'vconn', which must be an
 158      * active vconn.  If successful, returns 0, in which case ownership of
 159      * 'msg' is transferred to the vconn.  Success does not guarantee that
 160      * 'msg' has been or ever will be delivered to the peer, only that it has
 161      * been queued for transmission.
 162      *
 163      * Returns a positive errno value on failure, in which case the caller
 164      * retains ownership of 'msg'.
 165      *
 166      * The send function must not block.  If 'msg' cannot be immediately
 167      * accepted for transmission, it should return EAGAIN.
 168      *
 169      * Nonnull iff this is an active vconn (one that transfers data and does
 170      * not accept connections). */
 171     int (*send)(struct vconn *vconn, struct buffer *msg);
 172
 173     void (*wait)(struct vconn *vconn, enum vconn_wait_type);
 174 };
 175
 176 extern struct vconn_class tcp_vconn_class;
 177 extern struct vconn_class ptcp_vconn_class;
 178 extern struct vconn_class unix_vconn_class;
 179 extern struct vconn_class punix_vconn_class;
 180 #ifdef HAVE_OPENSSL
 181 extern struct vconn_class ssl_vconn_class;
 182 extern struct vconn_class pssl_vconn_class;
 183 #endif
 184 #ifdef HAVE_NETLINK
 185 extern struct vconn_class netlink_vconn_class;
 186 #endif
 187
 188 #endif /* vconn.h */