lib/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 ofpbuf;
  42 struct flow;
  43 struct ofp_header;
  44 struct pvconn;
  45 struct vconn;
  46
  47 void vconn_usage(bool active, bool passive, bool bootstrap);
  48
  49 /* Active vconns: virtual connections to OpenFlow devices. */
  50 int vconn_open(const char *name, int min_version, struct vconn **);
  51 void vconn_close(struct vconn *);
  52 const char *vconn_get_name(const struct vconn *);
  53 uint32_t vconn_get_ip(const struct vconn *);
  54 int vconn_connect(struct vconn *);
  55 int vconn_recv(struct vconn *, struct ofpbuf **);
  56 int vconn_send(struct vconn *, struct ofpbuf *);
  57 int vconn_recv_xid(struct vconn *, uint32_t xid, struct ofpbuf **);
  58 int vconn_transact(struct vconn *, struct ofpbuf *, struct ofpbuf **);
  59
  60 int vconn_open_block(const char *name, int min_version, struct vconn **);
  61 int vconn_send_block(struct vconn *, struct ofpbuf *);
  62 int vconn_recv_block(struct vconn *, struct ofpbuf **);
  63
  64 enum vconn_wait_type {
  65     WAIT_CONNECT,
  66     WAIT_RECV,
  67     WAIT_SEND
  68 };
  69 void vconn_wait(struct vconn *, enum vconn_wait_type);
  70 void vconn_connect_wait(struct vconn *);
  71 void vconn_recv_wait(struct vconn *);
  72 void vconn_send_wait(struct vconn *);
  73
  74 /* Passive vconns: virtual listeners for incoming OpenFlow connections. */
  75 int pvconn_open(const char *name, struct pvconn **);
  76 void pvconn_close(struct pvconn *);
  77 int pvconn_accept(struct pvconn *, int min_version, struct vconn **);
  78 void pvconn_wait(struct pvconn *);
  79
  80 /* OpenFlow protocol utility functions. */
  81 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
  82 void *make_openflow_xid(size_t openflow_len, uint8_t type,
  83                         uint32_t xid, struct ofpbuf **);
  84 void update_openflow_length(struct ofpbuf *);
  85 struct ofpbuf *make_add_flow(const struct flow *, uint32_t buffer_id,
  86                              uint16_t max_idle, size_t actions_len);
  87 struct ofpbuf *make_add_simple_flow(const struct flow *,
  88                                     uint32_t buffer_id, uint16_t out_port,
  89                                     uint16_t max_idle);
  90 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
  91                                         uint16_t in_port, uint16_t out_port);
  92 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
  93                                           uint16_t in_port, uint16_t out_port);
  94 struct ofpbuf *make_echo_request(void);
  95 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
  96
  97 #endif /* vconn.h */