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.
28 #include "openflow/openflow.h"
29 #include "poll-loop.h"
36 VLOG_DEFINE_THIS_MODULE(rconn);
38 COVERAGE_DEFINE(rconn_discarded);
39 COVERAGE_DEFINE(rconn_overflow);
40 COVERAGE_DEFINE(rconn_queued);
41 COVERAGE_DEFINE(rconn_sent);
45 STATE(BACKOFF, 1 << 1) \
46 STATE(CONNECTING, 1 << 2) \
47 STATE(ACTIVE, 1 << 3) \
50 #define STATE(NAME, VALUE) S_##NAME = VALUE,
56 state_name(enum state state)
59 #define STATE(NAME, VALUE) case S_##NAME: return #NAME;
66 /* A reliable connection to an OpenFlow switch or controller.
68 * See the large comment in rconn.h for more information. */
74 char *name; /* Human-readable descriptive name. */
75 char *target; /* vconn name, passed to vconn_open(). */
78 struct list txq; /* Contains "struct ofpbuf"s. */
82 time_t backoff_deadline;
83 time_t last_connected;
84 time_t last_disconnected;
85 unsigned int packets_sent;
89 /* In S_ACTIVE and S_IDLE, probably_admitted reports whether we believe
90 * that the peer has made a (positive) admission control decision on our
91 * connection. If we have not yet been (probably) admitted, then the
92 * connection does not reset the timer used for deciding whether the switch
93 * should go into fail-open mode.
95 * last_admitted reports the last time we believe such a positive admission
96 * control decision was made. */
97 bool probably_admitted;
100 /* These values are simply for statistics reporting, not used directly by
101 * anything internal to the rconn (or ofproto for that matter). */
102 unsigned int packets_received;
103 unsigned int n_attempted_connections, n_successful_connections;
104 time_t creation_time;
105 unsigned long int total_time_connected;
107 /* Throughout this file, "probe" is shorthand for "inactivity probe". When
108 * no activity has been observed from the peer for a while, we send out an
109 * echo request as an inactivity probe packet. We should receive back a
112 * "Activity" is defined as either receiving an OpenFlow message from the
113 * peer or successfully sending a message that had been in 'txq'. */
114 int probe_interval; /* Secs of inactivity before sending probe. */
115 time_t last_activity; /* Last time we saw some activity. */
117 /* When we create a vconn we obtain these values, to save them past the end
118 * of the vconn's lifetime. Otherwise, in-band control will only allow
119 * traffic when a vconn is actually open, but it is nice to allow ARP to
120 * complete even between connection attempts, and it is also polite to
121 * allow traffic from other switches to go through to the controller
122 * whether or not we are connected.
124 * We don't cache the local port, because that changes from one connection
125 * attempt to the next. */
126 ovs_be32 local_ip, remote_ip;
127 ovs_be16 remote_port;
130 /* Messages sent or received are copied to the monitor connections. */
131 #define MAX_MONITORS 8
132 struct vconn *monitors[8];
136 static unsigned int elapsed_in_this_state(const struct rconn *);
137 static unsigned int timeout(const struct rconn *);
138 static bool timed_out(const struct rconn *);
139 static void state_transition(struct rconn *, enum state);
140 static void rconn_set_target__(struct rconn *,
141 const char *target, const char *name);
142 static int try_send(struct rconn *);
143 static void reconnect(struct rconn *);
144 static void report_error(struct rconn *, int error);
145 static void disconnect(struct rconn *, int error);
146 static void flush_queue(struct rconn *);
147 static void copy_to_monitor(struct rconn *, const struct ofpbuf *);
148 static bool is_connected_state(enum state);
149 static bool is_admitted_msg(const struct ofpbuf *);
150 static bool rconn_logging_connection_attempts__(const struct rconn *);
152 /* Creates and returns a new rconn.
154 * 'probe_interval' is a number of seconds. If the interval passes once
155 * without an OpenFlow message being received from the peer, the rconn sends
156 * out an "echo request" message. If the interval passes again without a
157 * message being received, the rconn disconnects and re-connects to the peer.
158 * Setting 'probe_interval' to 0 disables this behavior.
160 * 'max_backoff' is the maximum number of seconds between attempts to connect
161 * to the peer. The actual interval starts at 1 second and doubles on each
162 * failure until it reaches 'max_backoff'. If 0 is specified, the default of
165 * The new rconn is initially unconnected. Use rconn_connect() or
166 * rconn_connect_unreliably() to connect it. */
168 rconn_create(int probe_interval, int max_backoff, uint8_t dscp)
170 struct rconn *rc = xzalloc(sizeof *rc);
173 rc->state_entered = time_now();
176 rc->name = xstrdup("void");
177 rc->target = xstrdup("void");
178 rc->reliable = false;
183 rc->max_backoff = max_backoff ? max_backoff : 8;
184 rc->backoff_deadline = TIME_MIN;
185 rc->last_connected = TIME_MIN;
186 rc->last_disconnected = TIME_MIN;
189 rc->packets_sent = 0;
191 rc->probably_admitted = false;
192 rc->last_admitted = time_now();
194 rc->packets_received = 0;
195 rc->n_attempted_connections = 0;
196 rc->n_successful_connections = 0;
197 rc->creation_time = time_now();
198 rc->total_time_connected = 0;
200 rc->last_activity = time_now();
202 rconn_set_probe_interval(rc, probe_interval);
203 rconn_set_dscp(rc, dscp);
211 rconn_set_max_backoff(struct rconn *rc, int max_backoff)
213 rc->max_backoff = MAX(1, max_backoff);
214 if (rc->state == S_BACKOFF && rc->backoff > max_backoff) {
215 rc->backoff = max_backoff;
216 if (rc->backoff_deadline > time_now() + max_backoff) {
217 rc->backoff_deadline = time_now() + max_backoff;
223 rconn_get_max_backoff(const struct rconn *rc)
225 return rc->max_backoff;
229 rconn_set_dscp(struct rconn *rc, uint8_t dscp)
235 rconn_get_dscp(const struct rconn *rc)
241 rconn_set_probe_interval(struct rconn *rc, int probe_interval)
243 rc->probe_interval = probe_interval ? MAX(5, probe_interval) : 0;
247 rconn_get_probe_interval(const struct rconn *rc)
249 return rc->probe_interval;
252 /* Drops any existing connection on 'rc', then sets up 'rc' to connect to
253 * 'target' and reconnect as needed. 'target' should be a remote OpenFlow
254 * target in a form acceptable to vconn_open().
256 * If 'name' is nonnull, then it is used in log messages in place of 'target'.
257 * It should presumably give more information to a human reader than 'target',
258 * but it need not be acceptable to vconn_open(). */
260 rconn_connect(struct rconn *rc, const char *target, const char *name)
262 rconn_disconnect(rc);
263 rconn_set_target__(rc, target, name);
268 /* Drops any existing connection on 'rc', then configures 'rc' to use
269 * 'vconn'. If the connection on 'vconn' drops, 'rc' will not reconnect on it
272 * By default, the target obtained from vconn_get_name(vconn) is used in log
273 * messages. If 'name' is nonnull, then it is used instead. It should
274 * presumably give more information to a human reader than the target, but it
275 * need not be acceptable to vconn_open(). */
277 rconn_connect_unreliably(struct rconn *rc,
278 struct vconn *vconn, const char *name)
280 assert(vconn != NULL);
281 rconn_disconnect(rc);
282 rconn_set_target__(rc, vconn_get_name(vconn), name);
283 rc->reliable = false;
285 rc->last_connected = time_now();
286 state_transition(rc, S_ACTIVE);
289 /* If 'rc' is connected, forces it to drop the connection and reconnect. */
291 rconn_reconnect(struct rconn *rc)
293 if (rc->state & (S_ACTIVE | S_IDLE)) {
294 VLOG_INFO("%s: disconnecting", rc->name);
300 rconn_disconnect(struct rconn *rc)
302 if (rc->state != S_VOID) {
304 vconn_close(rc->vconn);
307 rconn_set_target__(rc, "void", NULL);
308 rc->reliable = false;
311 rc->backoff_deadline = TIME_MIN;
313 state_transition(rc, S_VOID);
317 /* Disconnects 'rc' and frees the underlying storage. */
319 rconn_destroy(struct rconn *rc)
326 vconn_close(rc->vconn);
328 ofpbuf_list_delete(&rc->txq);
329 for (i = 0; i < rc->n_monitors; i++) {
330 vconn_close(rc->monitors[i]);
337 timeout_VOID(const struct rconn *rc OVS_UNUSED)
343 run_VOID(struct rconn *rc OVS_UNUSED)
349 reconnect(struct rconn *rc)
353 if (rconn_logging_connection_attempts__(rc)) {
354 VLOG_INFO("%s: connecting...", rc->name);
356 rc->n_attempted_connections++;
357 retval = vconn_open(rc->target, OFP10_VERSION, &rc->vconn, rc->dscp);
359 rc->remote_ip = vconn_get_remote_ip(rc->vconn);
360 rc->local_ip = vconn_get_local_ip(rc->vconn);
361 rc->remote_port = vconn_get_remote_port(rc->vconn);
362 rc->backoff_deadline = time_now() + rc->backoff;
363 state_transition(rc, S_CONNECTING);
365 VLOG_WARN("%s: connection failed (%s)", rc->name, strerror(retval));
366 rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
367 disconnect(rc, retval);
372 timeout_BACKOFF(const struct rconn *rc)
378 run_BACKOFF(struct rconn *rc)
386 timeout_CONNECTING(const struct rconn *rc)
388 return MAX(1, rc->backoff);
392 run_CONNECTING(struct rconn *rc)
394 int retval = vconn_connect(rc->vconn);
396 VLOG_INFO("%s: connected", rc->name);
397 rc->n_successful_connections++;
398 state_transition(rc, S_ACTIVE);
399 rc->last_connected = rc->state_entered;
400 } else if (retval != EAGAIN) {
401 if (rconn_logging_connection_attempts__(rc)) {
402 VLOG_INFO("%s: connection failed (%s)",
403 rc->name, strerror(retval));
405 disconnect(rc, retval);
406 } else if (timed_out(rc)) {
407 if (rconn_logging_connection_attempts__(rc)) {
408 VLOG_INFO("%s: connection timed out", rc->name);
410 rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
411 disconnect(rc, ETIMEDOUT);
416 do_tx_work(struct rconn *rc)
418 if (list_is_empty(&rc->txq)) {
421 while (!list_is_empty(&rc->txq)) {
422 int error = try_send(rc);
426 rc->last_activity = time_now();
428 if (list_is_empty(&rc->txq)) {
429 poll_immediate_wake();
434 timeout_ACTIVE(const struct rconn *rc)
436 if (rc->probe_interval) {
437 unsigned int base = MAX(rc->last_activity, rc->state_entered);
438 unsigned int arg = base + rc->probe_interval - rc->state_entered;
445 run_ACTIVE(struct rconn *rc)
448 unsigned int base = MAX(rc->last_activity, rc->state_entered);
449 VLOG_DBG("%s: idle %u seconds, sending inactivity probe",
450 rc->name, (unsigned int) (time_now() - base));
452 /* Ordering is important here: rconn_send() can transition to BACKOFF,
453 * and we don't want to transition back to IDLE if so, because then we
454 * can end up queuing a packet with vconn == NULL and then *boom*. */
455 state_transition(rc, S_IDLE);
456 rconn_send(rc, make_echo_request(), NULL);
464 timeout_IDLE(const struct rconn *rc)
466 return rc->probe_interval;
470 run_IDLE(struct rconn *rc)
473 VLOG_ERR("%s: no response to inactivity probe after %u "
474 "seconds, disconnecting",
475 rc->name, elapsed_in_this_state(rc));
476 disconnect(rc, ETIMEDOUT);
482 /* Performs whatever activities are necessary to maintain 'rc': if 'rc' is
483 * disconnected, attempts to (re)connect, backing off as necessary; if 'rc' is
484 * connected, attempts to send packets in the send queue, if any. */
486 rconn_run(struct rconn *rc)
492 vconn_run(rc->vconn);
494 for (i = 0; i < rc->n_monitors; i++) {
495 vconn_run(rc->monitors[i]);
499 old_state = rc->state;
501 #define STATE(NAME, VALUE) case S_##NAME: run_##NAME(rc); break;
507 } while (rc->state != old_state);
510 /* Causes the next call to poll_block() to wake up when rconn_run() should be
513 rconn_run_wait(struct rconn *rc)
519 vconn_run_wait(rc->vconn);
520 if ((rc->state & (S_ACTIVE | S_IDLE)) && !list_is_empty(&rc->txq)) {
521 vconn_wait(rc->vconn, WAIT_SEND);
524 for (i = 0; i < rc->n_monitors; i++) {
525 vconn_run_wait(rc->monitors[i]);
529 if (timeo != UINT_MAX) {
530 long long int expires = sat_add(rc->state_entered, timeo);
531 poll_timer_wait_until(expires * 1000);
535 /* Attempts to receive a packet from 'rc'. If successful, returns the packet;
536 * otherwise, returns a null pointer. The caller is responsible for freeing
537 * the packet (with ofpbuf_delete()). */
539 rconn_recv(struct rconn *rc)
541 if (rc->state & (S_ACTIVE | S_IDLE)) {
542 struct ofpbuf *buffer;
543 int error = vconn_recv(rc->vconn, &buffer);
545 copy_to_monitor(rc, buffer);
546 if (rc->probably_admitted || is_admitted_msg(buffer)
547 || time_now() - rc->last_connected >= 30) {
548 rc->probably_admitted = true;
549 rc->last_admitted = time_now();
551 rc->last_activity = time_now();
552 rc->packets_received++;
553 if (rc->state == S_IDLE) {
554 state_transition(rc, S_ACTIVE);
557 } else if (error != EAGAIN) {
558 report_error(rc, error);
559 disconnect(rc, error);
565 /* Causes the next call to poll_block() to wake up when a packet may be ready
566 * to be received by vconn_recv() on 'rc'. */
568 rconn_recv_wait(struct rconn *rc)
571 vconn_wait(rc->vconn, WAIT_RECV);
575 /* Sends 'b' on 'rc'. Returns 0 if successful, or ENOTCONN if 'rc' is not
576 * currently connected. Takes ownership of 'b'.
578 * If 'counter' is non-null, then 'counter' will be incremented while the
579 * packet is in flight, then decremented when it has been sent (or discarded
580 * due to disconnection). Because 'b' may be sent (or discarded) before this
581 * function returns, the caller may not be able to observe any change in
584 * There is no rconn_send_wait() function: an rconn has a send queue that it
585 * takes care of sending if you call rconn_run(), which will have the side
586 * effect of waking up poll_block(). */
588 rconn_send(struct rconn *rc, struct ofpbuf *b,
589 struct rconn_packet_counter *counter)
591 if (rconn_is_connected(rc)) {
592 COVERAGE_INC(rconn_queued);
593 copy_to_monitor(rc, b);
594 b->private_p = counter;
596 rconn_packet_counter_inc(counter, b->size);
598 list_push_back(&rc->txq, &b->list_node);
600 /* If the queue was empty before we added 'b', try to send some
601 * packets. (But if the queue had packets in it, it's because the
602 * vconn is backlogged and there's no point in stuffing more into it
603 * now. We'll get back to that in rconn_run().) */
604 if (rc->txq.next == &b->list_node) {
614 /* Sends 'b' on 'rc'. Increments 'counter' while the packet is in flight; it
615 * will be decremented when it has been sent (or discarded due to
616 * disconnection). Returns 0 if successful, EAGAIN if 'counter->n' is already
617 * at least as large as 'queue_limit', or ENOTCONN if 'rc' is not currently
618 * connected. Regardless of return value, 'b' is destroyed.
620 * Because 'b' may be sent (or discarded) before this function returns, the
621 * caller may not be able to observe any change in 'counter'.
623 * There is no rconn_send_wait() function: an rconn has a send queue that it
624 * takes care of sending if you call rconn_run(), which will have the side
625 * effect of waking up poll_block(). */
627 rconn_send_with_limit(struct rconn *rc, struct ofpbuf *b,
628 struct rconn_packet_counter *counter, int queue_limit)
631 retval = (counter->n_packets >= queue_limit
633 : rconn_send(rc, b, counter));
635 COVERAGE_INC(rconn_overflow);
640 /* Returns the total number of packets successfully sent on the underlying
641 * vconn. A packet is not counted as sent while it is still queued in the
642 * rconn, only when it has been successfuly passed to the vconn. */
644 rconn_packets_sent(const struct rconn *rc)
646 return rc->packets_sent;
649 /* Adds 'vconn' to 'rc' as a monitoring connection, to which all messages sent
650 * and received on 'rconn' will be copied. 'rc' takes ownership of 'vconn'. */
652 rconn_add_monitor(struct rconn *rc, struct vconn *vconn)
654 if (rc->n_monitors < ARRAY_SIZE(rc->monitors)) {
655 VLOG_INFO("new monitor connection from %s", vconn_get_name(vconn));
656 rc->monitors[rc->n_monitors++] = vconn;
658 VLOG_DBG("too many monitor connections, discarding %s",
659 vconn_get_name(vconn));
664 /* Returns 'rc''s name. This is a name for human consumption, appropriate for
665 * use in log messages. It is not necessarily a name that may be passed
666 * directly to, e.g., vconn_open(). */
668 rconn_get_name(const struct rconn *rc)
673 /* Sets 'rc''s name to 'new_name'. */
675 rconn_set_name(struct rconn *rc, const char *new_name)
678 rc->name = xstrdup(new_name);
681 /* Returns 'rc''s target. This is intended to be a string that may be passed
682 * directly to, e.g., vconn_open(). */
684 rconn_get_target(const struct rconn *rc)
689 /* Returns true if 'rconn' is connected or in the process of reconnecting,
690 * false if 'rconn' is disconnected and will not reconnect on its own. */
692 rconn_is_alive(const struct rconn *rconn)
694 return rconn->state != S_VOID;
697 /* Returns true if 'rconn' is connected, false otherwise. */
699 rconn_is_connected(const struct rconn *rconn)
701 return is_connected_state(rconn->state);
704 /* Returns true if 'rconn' is connected and thought to have been accepted by
705 * the peer's admission-control policy. */
707 rconn_is_admitted(const struct rconn *rconn)
709 return (rconn_is_connected(rconn)
710 && rconn->last_admitted >= rconn->last_connected);
713 /* Returns 0 if 'rconn' is currently connected and considered to have been
714 * accepted by the peer's admission-control policy, otherwise the number of
715 * seconds since 'rconn' was last in such a state. */
717 rconn_failure_duration(const struct rconn *rconn)
719 return rconn_is_admitted(rconn) ? 0 : time_now() - rconn->last_admitted;
722 /* Returns the IP address of the peer, or 0 if the peer's IP address is not
725 rconn_get_remote_ip(const struct rconn *rconn)
727 return rconn->remote_ip;
730 /* Returns the transport port of the peer, or 0 if the peer's port is not
733 rconn_get_remote_port(const struct rconn *rconn)
735 return rconn->remote_port;
738 /* Returns the IP address used to connect to the peer, or 0 if the
739 * connection is not an IP-based protocol or if its IP address is not
742 rconn_get_local_ip(const struct rconn *rconn)
744 return rconn->local_ip;
747 /* Returns the transport port used to connect to the peer, or 0 if the
748 * connection does not contain a port or if the port is not known. */
750 rconn_get_local_port(const struct rconn *rconn)
752 return rconn->vconn ? vconn_get_local_port(rconn->vconn) : 0;
755 /* Returns the OpenFlow version negotiated with the peer, or -1 if there is
756 * currently no connection or if version negotiation is not yet complete. */
758 rconn_get_version(const struct rconn *rconn)
760 return rconn->vconn ? vconn_get_version(rconn->vconn) : -1;
763 /* Returns the total number of packets successfully received by the underlying
766 rconn_packets_received(const struct rconn *rc)
768 return rc->packets_received;
771 /* Returns a string representing the internal state of 'rc'. The caller must
772 * not modify or free the string. */
774 rconn_get_state(const struct rconn *rc)
776 return state_name(rc->state);
779 /* Returns the time at which the last successful connection was made by
780 * 'rc'. Returns TIME_MIN if never connected. */
782 rconn_get_last_connection(const struct rconn *rc)
784 return rc->last_connected;
787 /* Returns the time at which 'rc' was last disconnected. Returns TIME_MIN
788 * if never disconnected. */
790 rconn_get_last_disconnect(const struct rconn *rc)
792 return rc->last_disconnected;
795 /* Returns 'rc''s current connection sequence number, a number that changes
796 * every time that 'rconn' connects or disconnects. */
798 rconn_get_connection_seqno(const struct rconn *rc)
803 /* Returns a value that explains why 'rc' last disconnected:
805 * - 0 means that the last disconnection was caused by a call to
806 * rconn_disconnect(), or that 'rc' is new and has not yet completed its
807 * initial connection or connection attempt.
809 * - EOF means that the connection was closed in the normal way by the peer.
811 * - A positive integer is an errno value that represents the error.
814 rconn_get_last_error(const struct rconn *rc)
816 return rc->last_error;
819 /* Returns the number of messages queued for transmission on 'rc'. */
821 rconn_count_txqlen(const struct rconn *rc)
823 return list_size(&rc->txq);
826 struct rconn_packet_counter *
827 rconn_packet_counter_create(void)
829 struct rconn_packet_counter *c = xzalloc(sizeof *c);
835 rconn_packet_counter_destroy(struct rconn_packet_counter *c)
838 assert(c->ref_cnt > 0);
839 if (!--c->ref_cnt && !c->n_packets) {
846 rconn_packet_counter_inc(struct rconn_packet_counter *c, unsigned int n_bytes)
849 c->n_bytes += n_bytes;
853 rconn_packet_counter_dec(struct rconn_packet_counter *c, unsigned int n_bytes)
855 assert(c->n_packets > 0);
856 assert(c->n_bytes >= n_bytes);
858 c->n_bytes -= n_bytes;
868 /* Set rc->target and rc->name to 'target' and 'name', respectively. If 'name'
869 * is null, 'target' is used.
871 * Also, clear out the cached IP address and port information, since changing
872 * the target also likely changes these values. */
874 rconn_set_target__(struct rconn *rc, const char *target, const char *name)
877 rc->name = xstrdup(name ? name : target);
879 rc->target = xstrdup(target);
885 /* Tries to send a packet from 'rc''s send buffer. Returns 0 if successful,
886 * otherwise a positive errno value. */
888 try_send(struct rconn *rc)
890 struct ofpbuf *msg = ofpbuf_from_list(rc->txq.next);
891 unsigned int n_bytes = msg->size;
892 struct rconn_packet_counter *counter = msg->private_p;
895 /* Eagerly remove 'msg' from the txq. We can't remove it from the list
896 * after sending, if sending is successful, because it is then owned by the
897 * vconn, which might have freed it already. */
898 list_remove(&msg->list_node);
900 retval = vconn_send(rc->vconn, msg);
902 list_push_front(&rc->txq, &msg->list_node);
903 if (retval != EAGAIN) {
904 report_error(rc, retval);
905 disconnect(rc, retval);
909 COVERAGE_INC(rconn_sent);
912 rconn_packet_counter_dec(counter, n_bytes);
917 /* Reports that 'error' caused 'rc' to disconnect. 'error' may be a positive
918 * errno value, or it may be EOF to indicate that the connection was closed
921 report_error(struct rconn *rc, int error)
924 /* If 'rc' isn't reliable, then we don't really expect this connection
925 * to last forever anyway (probably it's a connection that we received
926 * via accept()), so use DBG level to avoid cluttering the logs. */
927 enum vlog_level level = rc->reliable ? VLL_INFO : VLL_DBG;
928 VLOG(level, "%s: connection closed by peer", rc->name);
930 VLOG_WARN("%s: connection dropped (%s)", rc->name, strerror(error));
934 /* Disconnects 'rc' and records 'error' as the error that caused 'rc''s last
937 * - 0 means that this disconnection is due to a request by 'rc''s client,
938 * not due to any kind of network error.
940 * - EOF means that the connection was closed in the normal way by the peer.
942 * - A positive integer is an errno value that represents the error.
945 disconnect(struct rconn *rc, int error)
947 rc->last_error = error;
949 time_t now = time_now();
951 if (rc->state & (S_CONNECTING | S_ACTIVE | S_IDLE)) {
952 rc->last_disconnected = now;
953 vconn_close(rc->vconn);
958 if (now >= rc->backoff_deadline) {
960 } else if (rc->backoff < rc->max_backoff / 2) {
961 rc->backoff = MAX(1, 2 * rc->backoff);
962 VLOG_INFO("%s: waiting %d seconds before reconnect",
963 rc->name, rc->backoff);
965 if (rconn_logging_connection_attempts__(rc)) {
966 VLOG_INFO("%s: continuing to retry connections in the "
967 "background but suppressing further logging",
970 rc->backoff = rc->max_backoff;
972 rc->backoff_deadline = now + rc->backoff;
973 state_transition(rc, S_BACKOFF);
975 rc->last_disconnected = time_now();
976 rconn_disconnect(rc);
980 /* Drops all the packets from 'rc''s send queue and decrements their queue
983 flush_queue(struct rconn *rc)
985 if (list_is_empty(&rc->txq)) {
988 while (!list_is_empty(&rc->txq)) {
989 struct ofpbuf *b = ofpbuf_from_list(list_pop_front(&rc->txq));
990 struct rconn_packet_counter *counter = b->private_p;
992 rconn_packet_counter_dec(counter, b->size);
994 COVERAGE_INC(rconn_discarded);
997 poll_immediate_wake();
1001 elapsed_in_this_state(const struct rconn *rc)
1003 return time_now() - rc->state_entered;
1007 timeout(const struct rconn *rc)
1009 switch (rc->state) {
1010 #define STATE(NAME, VALUE) case S_##NAME: return timeout_##NAME(rc);
1019 timed_out(const struct rconn *rc)
1021 return time_now() >= sat_add(rc->state_entered, timeout(rc));
1025 state_transition(struct rconn *rc, enum state state)
1027 rc->seqno += (rc->state == S_ACTIVE) != (state == S_ACTIVE);
1028 if (is_connected_state(state) && !is_connected_state(rc->state)) {
1029 rc->probably_admitted = false;
1031 if (rconn_is_connected(rc)) {
1032 rc->total_time_connected += elapsed_in_this_state(rc);
1034 VLOG_DBG("%s: entering %s", rc->name, state_name(state));
1036 rc->state_entered = time_now();
1040 copy_to_monitor(struct rconn *rc, const struct ofpbuf *b)
1042 struct ofpbuf *clone = NULL;
1046 for (i = 0; i < rc->n_monitors; ) {
1047 struct vconn *vconn = rc->monitors[i];
1050 clone = ofpbuf_clone(b);
1052 retval = vconn_send(vconn, clone);
1055 } else if (retval != EAGAIN) {
1056 VLOG_DBG("%s: closing monitor connection to %s: %s",
1057 rconn_get_name(rc), vconn_get_name(vconn),
1059 rc->monitors[i] = rc->monitors[--rc->n_monitors];
1064 ofpbuf_delete(clone);
1068 is_connected_state(enum state state)
1070 return (state & (S_ACTIVE | S_IDLE)) != 0;
1074 is_admitted_msg(const struct ofpbuf *b)
1079 error = ofptype_decode(&type, b->data);
1087 case OFPTYPE_ECHO_REQUEST:
1088 case OFPTYPE_ECHO_REPLY:
1089 case OFPTYPE_FEATURES_REQUEST:
1090 case OFPTYPE_FEATURES_REPLY:
1091 case OFPTYPE_GET_CONFIG_REQUEST:
1092 case OFPTYPE_GET_CONFIG_REPLY:
1093 case OFPTYPE_SET_CONFIG:
1096 case OFPTYPE_PACKET_IN:
1097 case OFPTYPE_FLOW_REMOVED:
1098 case OFPTYPE_PORT_STATUS:
1099 case OFPTYPE_PACKET_OUT:
1100 case OFPTYPE_FLOW_MOD:
1101 case OFPTYPE_PORT_MOD:
1102 case OFPTYPE_BARRIER_REQUEST:
1103 case OFPTYPE_BARRIER_REPLY:
1104 case OFPTYPE_DESC_STATS_REQUEST:
1105 case OFPTYPE_DESC_STATS_REPLY:
1106 case OFPTYPE_FLOW_STATS_REQUEST:
1107 case OFPTYPE_FLOW_STATS_REPLY:
1108 case OFPTYPE_AGGREGATE_STATS_REQUEST:
1109 case OFPTYPE_AGGREGATE_STATS_REPLY:
1110 case OFPTYPE_TABLE_STATS_REQUEST:
1111 case OFPTYPE_TABLE_STATS_REPLY:
1112 case OFPTYPE_PORT_STATS_REQUEST:
1113 case OFPTYPE_PORT_STATS_REPLY:
1114 case OFPTYPE_QUEUE_STATS_REQUEST:
1115 case OFPTYPE_QUEUE_STATS_REPLY:
1116 case OFPTYPE_PORT_DESC_STATS_REQUEST:
1117 case OFPTYPE_PORT_DESC_STATS_REPLY:
1118 case OFPTYPE_ROLE_REQUEST:
1119 case OFPTYPE_ROLE_REPLY:
1120 case OFPTYPE_SET_FLOW_FORMAT:
1121 case OFPTYPE_FLOW_MOD_TABLE_ID:
1122 case OFPTYPE_SET_PACKET_IN_FORMAT:
1123 case OFPTYPE_FLOW_AGE:
1124 case OFPTYPE_SET_ASYNC_CONFIG:
1125 case OFPTYPE_SET_CONTROLLER_ID:
1126 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
1127 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
1128 case OFPTYPE_FLOW_MONITOR_CANCEL:
1129 case OFPTYPE_FLOW_MONITOR_PAUSED:
1130 case OFPTYPE_FLOW_MONITOR_RESUMED:
1136 /* Returns true if 'rc' is currently logging information about connection
1137 * attempts, false if logging should be suppressed because 'rc' hasn't
1138 * successuflly connected in too long. */
1140 rconn_logging_connection_attempts__(const struct rconn *rc)
1142 return rc->backoff < rc->max_backoff;