-/* Copyright (C) 2007 Board of Trustees, Leland Stanford Jr. University.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to
- * deal in the Software without restriction, including without limitation the
- * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
- * sell copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
- * IN THE SOFTWARE.
+/* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
+ * Junior University
+ *
+ * We are making the OpenFlow specification and associated documentation
+ * (Software) available for public use and benefit with the expectation
+ * that others will use, modify and enhance the Software and contribute
+ * those enhancements back to the community. However, since we would
+ * like to make the Software available for broadest use, with as few
+ * restrictions as possible permission is hereby granted, free of
+ * charge, to any person obtaining a copy of this Software to deal in
+ * the Software under the copyrights without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+ * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * The name and trademarks of copyright holder(s) may NOT be used in
+ * advertising or publicity pertaining to the Software or any
+ * derivatives without specific, written prior permission.
*/
#ifndef VCONN_H
#define VCONN_H 1
#include <stdbool.h>
+#include <stddef.h>
#include <stdint.h>
struct buffer;
struct flow;
struct pollfd;
+struct ofp_header;
/* Client interface. */
/* Virtual connection to an OpenFlow device. */
struct vconn {
struct vconn_class *class;
+ int connect_status;
+ uint32_t ip;
};
-/* What kind of operation do we want to perform? */
-enum {
- WANT_ACCEPT = 1 << 0, /* Want to accept a new connection. */
- WANT_RECV = 1 << 1, /* Want to receive a message. */
- WANT_SEND = 1 << 2 /* Want to send a message. */
-};
-
+void vconn_usage(bool active, bool passive);
int vconn_open(const char *name, struct vconn **);
void vconn_close(struct vconn *);
bool vconn_is_passive(const struct vconn *);
-void vconn_prepoll(struct vconn *, int want, struct pollfd *);
-void vconn_postpoll(struct vconn *, short int *revents);
+uint32_t vconn_get_ip(const struct vconn *);
+int vconn_connect(struct vconn *);
int vconn_accept(struct vconn *, struct vconn **);
int vconn_recv(struct vconn *, struct buffer **);
int vconn_send(struct vconn *, struct buffer *);
-int vconn_send_wait(struct vconn *, struct buffer *);
+int vconn_transact(struct vconn *, struct buffer *, struct buffer **);
+
+int vconn_open_block(const char *name, struct vconn **);
+int vconn_send_block(struct vconn *, struct buffer *);
+int vconn_recv_block(struct vconn *, struct buffer **);
+enum vconn_wait_type {
+ WAIT_CONNECT,
+ WAIT_ACCEPT,
+ WAIT_RECV,
+ WAIT_SEND
+};
+void vconn_wait(struct vconn *, enum vconn_wait_type);
+void vconn_connect_wait(struct vconn *);
+void vconn_accept_wait(struct vconn *);
+void vconn_recv_wait(struct vconn *);
+void vconn_send_wait(struct vconn *);
+
+void *make_openflow(size_t openflow_len, uint8_t type, struct buffer **);
+void *make_openflow_xid(size_t openflow_len, uint8_t type,
+ uint32_t xid, struct buffer **);
+void update_openflow_length(struct buffer *);
+struct buffer *make_add_flow(const struct flow *, uint32_t buffer_id,
+ uint16_t max_idle, size_t n_actions);
struct buffer *make_add_simple_flow(const struct flow *,
- uint32_t buffer_id, uint16_t out_port);
+ uint32_t buffer_id, uint16_t out_port,
+ uint16_t max_idle);
struct buffer *make_buffered_packet_out(uint32_t buffer_id,
uint16_t in_port, uint16_t out_port);
struct buffer *make_unbuffered_packet_out(const struct buffer *packet,
uint16_t in_port, uint16_t out_port);
+struct buffer *make_echo_request(void);
+struct buffer *make_echo_reply(const struct ofp_header *rq);
\f
/* Provider interface. */
/* Attempts to connect to an OpenFlow device. 'name' is the full
* connection name provided by the user, e.g. "nl:0", "tcp:1.2.3.4". This
* name is useful for error messages but must not be modified.
- *
+ *
* 'suffix' is a copy of 'name' following the colon and may be modified.
*
* Returns 0 if successful, otherwise a positive errno value. If
- * successful, stores a pointer to the new connection in '*vconnp'. */
+ * successful, stores a pointer to the new connection in '*vconnp'.
+ *
+ * The open function must not block waiting for a connection to complete.
+ * If the connection cannot be completed immediately, it should return
+ * EAGAIN (not EINPROGRESS, as returned by the connect system call) and
+ * continue the connection in the background. */
int (*open)(const char *name, char *suffix, struct vconn **vconnp);
/* Closes 'vconn' and frees associated memory. */
void (*close)(struct vconn *vconn);
- /* Called by the main loop before calling poll(), this function must
- * initialize 'pfd->fd' and 'pfd->events' appropriately so that poll() will
- * wake up when the connection becomes available for the operations
- * specified in 'want'. The prepoll function may also set bits in 'pfd' to
- * allow for internal processing. */
- void (*prepoll)(struct vconn *, int want, struct pollfd *pfd);
-
- /* Called by the main loop after calling poll(), this function may perform
- * any internal processing needed by the connection. It is provided with
- * the vconn file descriptor's status in '*revents', as reported by poll().
- *
- * The postpoll function should adjust '*revents' to reflect the status of
- * the connection from the caller's point of view: that is, upon return
- * '*revents & POLLIN' should indicate that a packet is (potentially) ready
- * to be read (for an active vconn) or a new connection is ready to be
- * accepted (for a passive vconn) and '*revents & POLLOUT' should indicate
- * that a packet is (potentially) ready to be written.
+ /* Tries to complete the connection on 'vconn', which must be an active
+ * vconn. If 'vconn''s connection is complete, returns 0 if the connection
+ * was successful or a positive errno value if it failed. If the
+ * connection is still in progress, returns EAGAIN.
*
- * This function may be a null pointer in a vconn class that has no use for
- * it, that is, if the vconn does not need to do any internal processing
- * and poll's revents out properly reflects the vconn's status. */
- void (*postpoll)(struct vconn *, short int *revents);
+ * The connect function must not block waiting for the connection to
+ * complete; instead, it should return EAGAIN immediately. */
+ int (*connect)(struct vconn *vconn);
/* Tries to accept a new connection on 'vconn', which must be a passive
* vconn. If successful, stores the new connection in '*new_vconnp' and
* The accept function must not block waiting for a connection. If no
* connection is ready to be accepted, it should return EAGAIN.
*
- * Nonnull iff this is a passive vconn (one that accepts connection and
+ * Nonnull iff this is a passive vconn (one that accepts connections and
* does not transfer data). */
int (*accept)(struct vconn *vconn, struct vconn **new_vconnp);
* Nonnull iff this is an active vconn (one that transfers data and does
* not accept connections). */
int (*send)(struct vconn *vconn, struct buffer *msg);
+
+ void (*wait)(struct vconn *vconn, enum vconn_wait_type);
};
extern struct vconn_class tcp_vconn_class;
extern struct vconn_class ptcp_vconn_class;
+extern struct vconn_class unix_vconn_class;
+extern struct vconn_class punix_vconn_class;
+#ifdef HAVE_OPENSSL
+extern struct vconn_class ssl_vconn_class;
+extern struct vconn_class pssl_vconn_class;
+#endif
#ifdef HAVE_NETLINK
extern struct vconn_class netlink_vconn_class;
#endif
git://git.onelab.eu / sliver-openvswitch.git / blobdiff