2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "vconn-provider.h"
22 #include <netinet/in.h>
27 #include "dynamic-string.h"
28 #include "fatal-signal.h"
30 #include "ofp-errors.h"
32 #include "ofp-print.h"
35 #include "openflow/nicira-ext.h"
36 #include "openflow/openflow.h"
38 #include "poll-loop.h"
42 #include "socket-util.h"
44 VLOG_DEFINE_THIS_MODULE(vconn);
46 COVERAGE_DEFINE(vconn_open);
47 COVERAGE_DEFINE(vconn_received);
48 COVERAGE_DEFINE(vconn_sent);
50 /* State of an active vconn.*/
52 /* This is the ordinary progression of states. */
53 VCS_CONNECTING, /* Underlying vconn is not connected. */
54 VCS_SEND_HELLO, /* Waiting to send OFPT_HELLO message. */
55 VCS_RECV_HELLO, /* Waiting to receive OFPT_HELLO message. */
56 VCS_CONNECTED, /* Connection established. */
58 /* These states are entered only when something goes wrong. */
59 VCS_SEND_ERROR, /* Sending OFPT_ERROR message. */
60 VCS_DISCONNECTED /* Connection failed or connection closed. */
63 static struct vconn_class *vconn_classes[] = {
71 static struct pvconn_class *pvconn_classes[] = {
79 /* Rate limit for individual OpenFlow messages going over the vconn, output at
80 * DBG level. This is very high because, if these are enabled, it is because
81 * we really need to see them. */
82 static struct vlog_rate_limit ofmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600);
84 /* Rate limit for OpenFlow message parse errors. These always indicate a bug
85 * in the peer and so there's not much point in showing a lot of them. */
86 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
88 static int do_recv(struct vconn *, struct ofpbuf **);
89 static int do_send(struct vconn *, struct ofpbuf *);
91 /* Check the validity of the vconn class structures. */
93 check_vconn_classes(void)
98 for (i = 0; i < ARRAY_SIZE(vconn_classes); i++) {
99 struct vconn_class *class = vconn_classes[i];
100 assert(class->name != NULL);
101 assert(class->open != NULL);
102 if (class->close || class->recv || class->send
103 || class->run || class->run_wait || class->wait) {
104 assert(class->close != NULL);
105 assert(class->recv != NULL);
106 assert(class->send != NULL);
107 assert(class->wait != NULL);
109 /* This class delegates to another one. */
113 for (i = 0; i < ARRAY_SIZE(pvconn_classes); i++) {
114 struct pvconn_class *class = pvconn_classes[i];
115 assert(class->name != NULL);
116 assert(class->listen != NULL);
117 if (class->close || class->accept || class->wait) {
118 assert(class->close != NULL);
119 assert(class->accept != NULL);
120 assert(class->wait != NULL);
122 /* This class delegates to another one. */
128 /* Prints information on active (if 'active') and passive (if 'passive')
129 * connection methods supported by the vconn. If 'bootstrap' is true, also
130 * advertises options to bootstrap the CA certificate. */
132 vconn_usage(bool active, bool passive, bool bootstrap OVS_UNUSED)
134 /* Really this should be implemented via callbacks into the vconn
135 * providers, but that seems too heavy-weight to bother with at the
140 printf("Active OpenFlow connection methods:\n");
141 printf(" tcp:IP[:PORT] "
142 "PORT (default: %d) at remote IP\n", OFP_TCP_PORT);
144 printf(" ssl:IP[:PORT] "
145 "SSL PORT (default: %d) at remote IP\n", OFP_SSL_PORT);
147 printf(" unix:FILE Unix domain socket named FILE\n");
151 printf("Passive OpenFlow connection methods:\n");
152 printf(" ptcp:[PORT][:IP] "
153 "listen to TCP PORT (default: %d) on IP\n",
156 printf(" pssl:[PORT][:IP] "
157 "listen for SSL on PORT (default: %d) on IP\n",
160 printf(" punix:FILE "
161 "listen on Unix domain socket FILE\n");
165 printf("PKI configuration (required to use SSL):\n"
166 " -p, --private-key=FILE file with private key\n"
167 " -c, --certificate=FILE file with certificate for private key\n"
168 " -C, --ca-cert=FILE file with peer CA certificate\n");
170 printf(" --bootstrap-ca-cert=FILE file with peer CA certificate "
171 "to read or create\n");
176 /* Given 'name', a connection name in the form "TYPE:ARGS", stores the class
177 * named "TYPE" into '*classp' and returns 0. Returns EAFNOSUPPORT and stores
178 * a null pointer into '*classp' if 'name' is in the wrong form or if no such
181 vconn_lookup_class(const char *name, struct vconn_class **classp)
185 prefix_len = strcspn(name, ":");
186 if (name[prefix_len] != '\0') {
189 for (i = 0; i < ARRAY_SIZE(vconn_classes); i++) {
190 struct vconn_class *class = vconn_classes[i];
191 if (strlen(class->name) == prefix_len
192 && !memcmp(class->name, name, prefix_len)) {
203 /* Returns 0 if 'name' is a connection name in the form "TYPE:ARGS" and TYPE is
204 * a supported connection type, otherwise EAFNOSUPPORT. */
206 vconn_verify_name(const char *name)
208 struct vconn_class *class;
209 return vconn_lookup_class(name, &class);
212 /* Attempts to connect to an OpenFlow device. 'name' is a connection name in
213 * the form "TYPE:ARGS", where TYPE is an active vconn class's name and ARGS
214 * are vconn class-specific.
216 * The vconn will automatically negotiate an OpenFlow protocol version
217 * acceptable to both peers on the connection. The version negotiated will be
218 * no lower than 'min_version' and no higher than OFP10_VERSION.
220 * Returns 0 if successful, otherwise a positive errno value. If successful,
221 * stores a pointer to the new connection in '*vconnp', otherwise a null
224 vconn_open(const char *name, int min_version, struct vconn **vconnp,
227 struct vconn_class *class;
232 COVERAGE_INC(vconn_open);
233 check_vconn_classes();
235 /* Look up the class. */
236 error = vconn_lookup_class(name, &class);
241 /* Call class's "open" function. */
242 suffix_copy = xstrdup(strchr(name, ':') + 1);
243 error = class->open(name, suffix_copy, &vconn, dscp);
250 assert(vconn->state != VCS_CONNECTING || vconn->class->connect);
251 vconn->min_version = min_version;
260 /* Allows 'vconn' to perform maintenance activities, such as flushing output
263 vconn_run(struct vconn *vconn)
265 if (vconn->state == VCS_CONNECTING ||
266 vconn->state == VCS_SEND_HELLO ||
267 vconn->state == VCS_RECV_HELLO) {
268 vconn_connect(vconn);
271 if (vconn->class->run) {
272 (vconn->class->run)(vconn);
276 /* Arranges for the poll loop to wake up when 'vconn' needs to perform
277 * maintenance activities. */
279 vconn_run_wait(struct vconn *vconn)
281 if (vconn->state == VCS_CONNECTING ||
282 vconn->state == VCS_SEND_HELLO ||
283 vconn->state == VCS_RECV_HELLO) {
284 vconn_connect_wait(vconn);
287 if (vconn->class->run_wait) {
288 (vconn->class->run_wait)(vconn);
293 vconn_open_block(const char *name, enum ofp_version min_version,
294 struct vconn **vconnp)
301 error = vconn_open(name, min_version, &vconn, DSCP_DEFAULT);
303 error = vconn_connect_block(vconn);
315 /* Closes 'vconn'. */
317 vconn_close(struct vconn *vconn)
320 char *name = vconn->name;
321 (vconn->class->close)(vconn);
326 /* Returns the name of 'vconn', that is, the string passed to vconn_open(). */
328 vconn_get_name(const struct vconn *vconn)
333 /* Returns the IP address of the peer, or 0 if the peer is not connected over
334 * an IP-based protocol or if its IP address is not yet known. */
336 vconn_get_remote_ip(const struct vconn *vconn)
338 return vconn->remote_ip;
341 /* Returns the transport port of the peer, or 0 if the connection does not
342 * contain a port or if the port is not yet known. */
344 vconn_get_remote_port(const struct vconn *vconn)
346 return vconn->remote_port;
349 /* Returns the IP address used to connect to the peer, or 0 if the
350 * connection is not an IP-based protocol or if its IP address is not
353 vconn_get_local_ip(const struct vconn *vconn)
355 return vconn->local_ip;
358 /* Returns the transport port used to connect to the peer, or 0 if the
359 * connection does not contain a port or if the port is not yet known. */
361 vconn_get_local_port(const struct vconn *vconn)
363 return vconn->local_port;
366 /* Returns the OpenFlow version negotiated with the peer, or -1 if version
367 * negotiation is not yet complete.
369 * A vconn that has successfully connected (that is, vconn_connect() or
370 * vconn_send() or vconn_recv() has returned 0) always negotiated a version. */
372 vconn_get_version(const struct vconn *vconn)
374 return vconn->version ? vconn->version : -1;
378 vcs_connecting(struct vconn *vconn)
380 int retval = (vconn->class->connect)(vconn);
381 assert(retval != EINPROGRESS);
383 vconn->state = VCS_SEND_HELLO;
384 } else if (retval != EAGAIN) {
385 vconn->state = VCS_DISCONNECTED;
386 vconn->error = retval;
391 vcs_send_hello(struct vconn *vconn)
396 b = ofpraw_alloc(OFPRAW_OFPT_HELLO, OFP10_VERSION, 0);
397 retval = do_send(vconn, b);
399 vconn->state = VCS_RECV_HELLO;
402 if (retval != EAGAIN) {
403 vconn->state = VCS_DISCONNECTED;
404 vconn->error = retval;
410 vcs_recv_hello(struct vconn *vconn)
415 retval = do_recv(vconn, &b);
417 const struct ofp_header *oh = b->data;
421 error = ofptype_decode(&type, b->data);
422 if (!error && type == OFPTYPE_HELLO) {
423 if (b->size > sizeof *oh) {
424 struct ds msg = DS_EMPTY_INITIALIZER;
425 ds_put_format(&msg, "%s: extra-long hello:\n", vconn->name);
426 ds_put_hex_dump(&msg, b->data, b->size, 0, true);
427 VLOG_WARN_RL(&bad_ofmsg_rl, "%s", ds_cstr(&msg));
431 vconn->version = MIN(OFP10_VERSION, oh->version);
432 if (vconn->version < vconn->min_version) {
433 VLOG_WARN_RL(&bad_ofmsg_rl,
434 "%s: version negotiation failed: we support "
435 "versions 0x%02x to 0x%02x inclusive but peer "
436 "supports no later than version 0x%02"PRIx8,
437 vconn->name, vconn->min_version, OFP10_VERSION,
439 vconn->state = VCS_SEND_ERROR;
441 VLOG_DBG("%s: negotiated OpenFlow version 0x%02x "
442 "(we support versions 0x%02x to 0x%02x inclusive, "
443 "peer no later than version 0x%02"PRIx8")",
444 vconn->name, vconn->version, vconn->min_version,
445 OFP10_VERSION, oh->version);
446 vconn->state = VCS_CONNECTED;
451 char *s = ofp_to_string(b->data, b->size, 1);
452 VLOG_WARN_RL(&bad_ofmsg_rl,
453 "%s: received message while expecting hello: %s",
461 if (retval != EAGAIN) {
462 vconn->state = VCS_DISCONNECTED;
463 vconn->error = retval == EOF ? ECONNRESET : retval;
468 vcs_send_error(struct vconn *vconn)
474 snprintf(s, sizeof s, "We support versions 0x%02x to 0x%02x inclusive but "
475 "you support no later than version 0x%02"PRIx8".",
476 vconn->min_version, OFP12_VERSION, vconn->version);
477 b = ofperr_encode_hello(OFPERR_OFPHFC_INCOMPATIBLE, vconn->version, s);
478 retval = do_send(vconn, b);
482 if (retval != EAGAIN) {
483 vconn->state = VCS_DISCONNECTED;
484 vconn->error = retval ? retval : EPROTO;
488 /* Tries to complete the connection on 'vconn'. If 'vconn''s connection is
489 * complete, returns 0 if the connection was successful or a positive errno
490 * value if it failed. If the connection is still in progress, returns
493 vconn_connect(struct vconn *vconn)
495 enum vconn_state last_state;
497 assert(vconn->min_version > 0);
499 last_state = vconn->state;
500 switch (vconn->state) {
502 vcs_connecting(vconn);
506 vcs_send_hello(vconn);
510 vcs_recv_hello(vconn);
517 vcs_send_error(vconn);
520 case VCS_DISCONNECTED:
526 } while (vconn->state != last_state);
531 /* Tries to receive an OpenFlow message from 'vconn'. If successful, stores
532 * the received message into '*msgp' and returns 0. The caller is responsible
533 * for destroying the message with ofpbuf_delete(). On failure, returns a
534 * positive errno value and stores a null pointer into '*msgp'. On normal
535 * connection close, returns EOF.
537 * vconn_recv will not block waiting for a packet to arrive. If no packets
538 * have been received, it returns EAGAIN immediately. */
540 vconn_recv(struct vconn *vconn, struct ofpbuf **msgp)
545 retval = vconn_connect(vconn);
547 retval = do_recv(vconn, &msg);
550 const struct ofp_header *oh = msg->data;
551 if (oh->version != vconn->version) {
554 if (ofptype_decode(&type, msg->data)
555 || (type != OFPTYPE_HELLO &&
556 type != OFPTYPE_ERROR &&
557 type != OFPTYPE_ECHO_REQUEST &&
558 type != OFPTYPE_ECHO_REPLY)) {
559 VLOG_ERR_RL(&bad_ofmsg_rl, "%s: received OpenFlow version "
560 "0x%02"PRIx8" != expected %02x",
561 vconn->name, oh->version, vconn->version);
568 *msgp = retval ? NULL : msg;
573 do_recv(struct vconn *vconn, struct ofpbuf **msgp)
575 int retval = (vconn->class->recv)(vconn, msgp);
577 COVERAGE_INC(vconn_received);
578 if (VLOG_IS_DBG_ENABLED()) {
579 char *s = ofp_to_string((*msgp)->data, (*msgp)->size, 1);
580 VLOG_DBG_RL(&ofmsg_rl, "%s: received: %s", vconn->name, s);
587 /* Tries to queue 'msg' for transmission on 'vconn'. If successful, returns 0,
588 * in which case ownership of 'msg' is transferred to the vconn. Success does
589 * not guarantee that 'msg' has been or ever will be delivered to the peer,
590 * only that it has been queued for transmission.
592 * Returns a positive errno value on failure, in which case the caller
593 * retains ownership of 'msg'.
595 * vconn_send will not block. If 'msg' cannot be immediately accepted for
596 * transmission, it returns EAGAIN immediately. */
598 vconn_send(struct vconn *vconn, struct ofpbuf *msg)
600 int retval = vconn_connect(vconn);
602 retval = do_send(vconn, msg);
608 do_send(struct vconn *vconn, struct ofpbuf *msg)
612 assert(msg->size >= sizeof(struct ofp_header));
614 ofpmsg_update_length(msg);
615 if (!VLOG_IS_DBG_ENABLED()) {
616 COVERAGE_INC(vconn_sent);
617 retval = (vconn->class->send)(vconn, msg);
619 char *s = ofp_to_string(msg->data, msg->size, 1);
620 retval = (vconn->class->send)(vconn, msg);
621 if (retval != EAGAIN) {
622 VLOG_DBG_RL(&ofmsg_rl, "%s: sent (%s): %s",
623 vconn->name, strerror(retval), s);
630 /* Same as vconn_connect(), except that it waits until the connection on
631 * 'vconn' completes or fails. Thus, it will never return EAGAIN. */
633 vconn_connect_block(struct vconn *vconn)
637 while ((error = vconn_connect(vconn)) == EAGAIN) {
639 vconn_run_wait(vconn);
640 vconn_connect_wait(vconn);
643 assert(error != EINPROGRESS);
648 /* Same as vconn_send, except that it waits until 'msg' can be transmitted. */
650 vconn_send_block(struct vconn *vconn, struct ofpbuf *msg)
656 while ((retval = vconn_send(vconn, msg)) == EAGAIN) {
658 vconn_run_wait(vconn);
659 vconn_send_wait(vconn);
665 /* Same as vconn_recv, except that it waits until a message is received. */
667 vconn_recv_block(struct vconn *vconn, struct ofpbuf **msgp)
673 while ((retval = vconn_recv(vconn, msgp)) == EAGAIN) {
675 vconn_run_wait(vconn);
676 vconn_recv_wait(vconn);
682 /* Waits until a message with a transaction ID matching 'xid' is recived on
683 * 'vconn'. Returns 0 if successful, in which case the reply is stored in
684 * '*replyp' for the caller to examine and free. Otherwise returns a positive
685 * errno value, or EOF, and sets '*replyp' to null.
687 * 'request' is always destroyed, regardless of the return value. */
689 vconn_recv_xid(struct vconn *vconn, ovs_be32 xid, struct ofpbuf **replyp)
693 struct ofpbuf *reply;
696 error = vconn_recv_block(vconn, &reply);
701 recv_xid = ((struct ofp_header *) reply->data)->xid;
702 if (xid == recv_xid) {
707 VLOG_DBG_RL(&bad_ofmsg_rl, "%s: received reply with xid %08"PRIx32
708 " != expected %08"PRIx32,
709 vconn->name, ntohl(recv_xid), ntohl(xid));
710 ofpbuf_delete(reply);
714 /* Sends 'request' to 'vconn' and blocks until it receives a reply with a
715 * matching transaction ID. Returns 0 if successful, in which case the reply
716 * is stored in '*replyp' for the caller to examine and free. Otherwise
717 * returns a positive errno value, or EOF, and sets '*replyp' to null.
719 * 'request' should be an OpenFlow request that requires a reply. Otherwise,
720 * if there is no reply, this function can end up blocking forever (or until
721 * the peer drops the connection).
723 * 'request' is always destroyed, regardless of the return value. */
725 vconn_transact(struct vconn *vconn, struct ofpbuf *request,
726 struct ofpbuf **replyp)
728 ovs_be32 send_xid = ((struct ofp_header *) request->data)->xid;
732 error = vconn_send_block(vconn, request);
734 ofpbuf_delete(request);
736 return error ? error : vconn_recv_xid(vconn, send_xid, replyp);
739 /* Sends 'request' followed by a barrier request to 'vconn', then blocks until
740 * it receives a reply to the barrier. If successful, stores the reply to
741 * 'request' in '*replyp', if one was received, and otherwise NULL, then
742 * returns 0. Otherwise returns a positive errno value, or EOF, and sets
745 * This function is useful for sending an OpenFlow request that doesn't
746 * ordinarily include a reply but might report an error in special
749 * 'request' is always destroyed, regardless of the return value. */
751 vconn_transact_noreply(struct vconn *vconn, struct ofpbuf *request,
752 struct ofpbuf **replyp)
754 ovs_be32 request_xid;
755 ovs_be32 barrier_xid;
756 struct ofpbuf *barrier;
762 request_xid = ((struct ofp_header *) request->data)->xid;
763 error = vconn_send_block(vconn, request);
765 ofpbuf_delete(request);
770 barrier = ofputil_encode_barrier_request(vconn_get_version(vconn));
771 barrier_xid = ((struct ofp_header *) barrier->data)->xid;
772 error = vconn_send_block(vconn, barrier);
774 ofpbuf_delete(barrier);
783 error = vconn_recv_block(vconn, &msg);
785 ofpbuf_delete(*replyp);
790 msg_xid = ((struct ofp_header *) msg->data)->xid;
791 if (msg_xid == request_xid) {
793 VLOG_WARN_RL(&bad_ofmsg_rl, "%s: duplicate replies with "
794 "xid %08"PRIx32, vconn->name, ntohl(msg_xid));
795 ofpbuf_delete(*replyp);
800 if (msg_xid == barrier_xid) {
803 VLOG_DBG_RL(&bad_ofmsg_rl, "%s: reply with xid %08"PRIx32
804 " != expected %08"PRIx32" or %08"PRIx32,
805 vconn->name, ntohl(msg_xid),
806 ntohl(request_xid), ntohl(barrier_xid));
812 /* vconn_transact_noreply() for a list of "struct ofpbuf"s, sent one by one.
813 * All of the requests on 'requests' are always destroyed, regardless of the
816 vconn_transact_multiple_noreply(struct vconn *vconn, struct list *requests,
817 struct ofpbuf **replyp)
819 struct ofpbuf *request, *next;
821 LIST_FOR_EACH_SAFE (request, next, list_node, requests) {
824 list_remove(&request->list_node);
826 error = vconn_transact_noreply(vconn, request, replyp);
827 if (error || *replyp) {
828 ofpbuf_list_delete(requests);
838 vconn_wait(struct vconn *vconn, enum vconn_wait_type wait)
840 assert(wait == WAIT_CONNECT || wait == WAIT_RECV || wait == WAIT_SEND);
842 switch (vconn->state) {
859 case VCS_DISCONNECTED:
860 poll_immediate_wake();
863 (vconn->class->wait)(vconn, wait);
867 vconn_connect_wait(struct vconn *vconn)
869 vconn_wait(vconn, WAIT_CONNECT);
873 vconn_recv_wait(struct vconn *vconn)
875 vconn_wait(vconn, WAIT_RECV);
879 vconn_send_wait(struct vconn *vconn)
881 vconn_wait(vconn, WAIT_SEND);
884 /* Given 'name', a connection name in the form "TYPE:ARGS", stores the class
885 * named "TYPE" into '*classp' and returns 0. Returns EAFNOSUPPORT and stores
886 * a null pointer into '*classp' if 'name' is in the wrong form or if no such
889 pvconn_lookup_class(const char *name, struct pvconn_class **classp)
893 prefix_len = strcspn(name, ":");
894 if (name[prefix_len] != '\0') {
897 for (i = 0; i < ARRAY_SIZE(pvconn_classes); i++) {
898 struct pvconn_class *class = pvconn_classes[i];
899 if (strlen(class->name) == prefix_len
900 && !memcmp(class->name, name, prefix_len)) {
911 /* Returns 0 if 'name' is a connection name in the form "TYPE:ARGS" and TYPE is
912 * a supported connection type, otherwise EAFNOSUPPORT. */
914 pvconn_verify_name(const char *name)
916 struct pvconn_class *class;
917 return pvconn_lookup_class(name, &class);
920 /* Attempts to start listening for OpenFlow connections. 'name' is a
921 * connection name in the form "TYPE:ARGS", where TYPE is an passive vconn
922 * class's name and ARGS are vconn class-specific.
924 * Returns 0 if successful, otherwise a positive errno value. If successful,
925 * stores a pointer to the new connection in '*pvconnp', otherwise a null
928 pvconn_open(const char *name, struct pvconn **pvconnp, uint8_t dscp)
930 struct pvconn_class *class;
931 struct pvconn *pvconn;
935 check_vconn_classes();
937 /* Look up the class. */
938 error = pvconn_lookup_class(name, &class);
943 /* Call class's "open" function. */
944 suffix_copy = xstrdup(strchr(name, ':') + 1);
945 error = class->listen(name, suffix_copy, &pvconn, dscp);
960 /* Returns the name that was used to open 'pvconn'. The caller must not
961 * modify or free the name. */
963 pvconn_get_name(const struct pvconn *pvconn)
968 /* Closes 'pvconn'. */
970 pvconn_close(struct pvconn *pvconn)
972 if (pvconn != NULL) {
973 char *name = pvconn->name;
974 (pvconn->class->close)(pvconn);
979 /* Tries to accept a new connection on 'pvconn'. If successful, stores the new
980 * connection in '*new_vconn' and returns 0. Otherwise, returns a positive
983 * The new vconn will automatically negotiate an OpenFlow protocol version
984 * acceptable to both peers on the connection. The version negotiated will be
985 * no lower than 'min_version' and no higher than OFP10_VERSION.
987 * pvconn_accept() will not block waiting for a connection. If no connection
988 * is ready to be accepted, it returns EAGAIN immediately. */
990 pvconn_accept(struct pvconn *pvconn, int min_version, struct vconn **new_vconn)
992 int retval = (pvconn->class->accept)(pvconn, new_vconn);
996 assert((*new_vconn)->state != VCS_CONNECTING
997 || (*new_vconn)->class->connect);
998 (*new_vconn)->min_version = min_version;
1004 pvconn_wait(struct pvconn *pvconn)
1006 (pvconn->class->wait)(pvconn);
1009 /* Initializes 'vconn' as a new vconn named 'name', implemented via 'class'.
1010 * The initial connection status, supplied as 'connect_status', is interpreted
1013 * - 0: 'vconn' is connected. Its 'send' and 'recv' functions may be
1014 * called in the normal fashion.
1016 * - EAGAIN: 'vconn' is trying to complete a connection. Its 'connect'
1017 * function should be called to complete the connection.
1019 * - Other positive errno values indicate that the connection failed with
1020 * the specified error.
1022 * After calling this function, vconn_close() must be used to destroy 'vconn',
1023 * otherwise resources will be leaked.
1025 * The caller retains ownership of 'name'. */
1027 vconn_init(struct vconn *vconn, struct vconn_class *class, int connect_status,
1030 vconn->class = class;
1031 vconn->state = (connect_status == EAGAIN ? VCS_CONNECTING
1032 : !connect_status ? VCS_SEND_HELLO
1033 : VCS_DISCONNECTED);
1034 vconn->error = connect_status;
1036 vconn->min_version = 0;
1037 vconn->remote_ip = 0;
1038 vconn->remote_port = 0;
1039 vconn->local_ip = 0;
1040 vconn->local_port = 0;
1041 vconn->name = xstrdup(name);
1042 assert(vconn->state != VCS_CONNECTING || class->connect);
1046 vconn_set_remote_ip(struct vconn *vconn, ovs_be32 ip)
1048 vconn->remote_ip = ip;
1052 vconn_set_remote_port(struct vconn *vconn, ovs_be16 port)
1054 vconn->remote_port = port;
1058 vconn_set_local_ip(struct vconn *vconn, ovs_be32 ip)
1060 vconn->local_ip = ip;
1064 vconn_set_local_port(struct vconn *vconn, ovs_be16 port)
1066 vconn->local_port = port;
1070 pvconn_init(struct pvconn *pvconn, struct pvconn_class *class,
1073 pvconn->class = class;
1074 pvconn->name = xstrdup(name);