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];
135 uint32_t allowed_versions;
138 static unsigned int elapsed_in_this_state(const struct rconn *);
139 static unsigned int timeout(const struct rconn *);
140 static bool timed_out(const struct rconn *);
141 static void state_transition(struct rconn *, enum state);
142 static void rconn_set_target__(struct rconn *,
143 const char *target, const char *name);
144 static int try_send(struct rconn *);
145 static void reconnect(struct rconn *);
146 static void report_error(struct rconn *, int error);
147 static void disconnect(struct rconn *, int error);
148 static void flush_queue(struct rconn *);
149 static void copy_to_monitor(struct rconn *, const struct ofpbuf *);
150 static bool is_connected_state(enum state);
151 static bool is_admitted_msg(const struct ofpbuf *);
152 static bool rconn_logging_connection_attempts__(const struct rconn *);
154 /* Creates and returns a new rconn.
156 * 'probe_interval' is a number of seconds. If the interval passes once
157 * without an OpenFlow message being received from the peer, the rconn sends
158 * out an "echo request" message. If the interval passes again without a
159 * message being received, the rconn disconnects and re-connects to the peer.
160 * Setting 'probe_interval' to 0 disables this behavior.
162 * 'max_backoff' is the maximum number of seconds between attempts to connect
163 * to the peer. The actual interval starts at 1 second and doubles on each
164 * failure until it reaches 'max_backoff'. If 0 is specified, the default of
167 * The new rconn is initially unconnected. Use rconn_connect() or
168 * rconn_connect_unreliably() to connect it.
170 * Connections made by the rconn will automatically negotiate an OpenFlow
171 * protocol version acceptable to both peers on the connection. The version
172 * negotiated will be one of those in the 'allowed_versions' bitmap:
173 * version 'x' is allowed if allowed_versions & (1 << x) is nonzero. If
174 * 'allowed_versions' is zero, then OFPUTIL_DEFAULT_VERSIONS are allowed.
177 rconn_create(int probe_interval, int max_backoff, uint8_t dscp,
178 uint32_t allowed_versions)
180 struct rconn *rc = xzalloc(sizeof *rc);
183 rc->state_entered = time_now();
186 rc->name = xstrdup("void");
187 rc->target = xstrdup("void");
188 rc->reliable = false;
193 rc->max_backoff = max_backoff ? max_backoff : 8;
194 rc->backoff_deadline = TIME_MIN;
195 rc->last_connected = TIME_MIN;
196 rc->last_disconnected = TIME_MIN;
199 rc->packets_sent = 0;
201 rc->probably_admitted = false;
202 rc->last_admitted = time_now();
204 rc->packets_received = 0;
205 rc->n_attempted_connections = 0;
206 rc->n_successful_connections = 0;
207 rc->creation_time = time_now();
208 rc->total_time_connected = 0;
210 rc->last_activity = time_now();
212 rconn_set_probe_interval(rc, probe_interval);
213 rconn_set_dscp(rc, dscp);
216 rc->allowed_versions = allowed_versions
218 : OFPUTIL_DEFAULT_VERSIONS;
224 rconn_set_max_backoff(struct rconn *rc, int max_backoff)
226 rc->max_backoff = MAX(1, max_backoff);
227 if (rc->state == S_BACKOFF && rc->backoff > max_backoff) {
228 rc->backoff = max_backoff;
229 if (rc->backoff_deadline > time_now() + max_backoff) {
230 rc->backoff_deadline = time_now() + max_backoff;
236 rconn_get_max_backoff(const struct rconn *rc)
238 return rc->max_backoff;
242 rconn_set_dscp(struct rconn *rc, uint8_t dscp)
248 rconn_get_dscp(const struct rconn *rc)
254 rconn_set_probe_interval(struct rconn *rc, int probe_interval)
256 rc->probe_interval = probe_interval ? MAX(5, probe_interval) : 0;
260 rconn_get_probe_interval(const struct rconn *rc)
262 return rc->probe_interval;
265 /* Drops any existing connection on 'rc', then sets up 'rc' to connect to
266 * 'target' and reconnect as needed. 'target' should be a remote OpenFlow
267 * target in a form acceptable to vconn_open().
269 * If 'name' is nonnull, then it is used in log messages in place of 'target'.
270 * It should presumably give more information to a human reader than 'target',
271 * but it need not be acceptable to vconn_open(). */
273 rconn_connect(struct rconn *rc, const char *target, const char *name)
275 rconn_disconnect(rc);
276 rconn_set_target__(rc, target, name);
281 /* Drops any existing connection on 'rc', then configures 'rc' to use
282 * 'vconn'. If the connection on 'vconn' drops, 'rc' will not reconnect on it
285 * By default, the target obtained from vconn_get_name(vconn) is used in log
286 * messages. If 'name' is nonnull, then it is used instead. It should
287 * presumably give more information to a human reader than the target, but it
288 * need not be acceptable to vconn_open(). */
290 rconn_connect_unreliably(struct rconn *rc,
291 struct vconn *vconn, const char *name)
293 assert(vconn != NULL);
294 rconn_disconnect(rc);
295 rconn_set_target__(rc, vconn_get_name(vconn), name);
296 rc->reliable = false;
298 rc->last_connected = time_now();
299 state_transition(rc, S_ACTIVE);
302 /* If 'rc' is connected, forces it to drop the connection and reconnect. */
304 rconn_reconnect(struct rconn *rc)
306 if (rc->state & (S_ACTIVE | S_IDLE)) {
307 VLOG_INFO("%s: disconnecting", rc->name);
313 rconn_disconnect(struct rconn *rc)
315 if (rc->state != S_VOID) {
317 vconn_close(rc->vconn);
320 rconn_set_target__(rc, "void", NULL);
321 rc->reliable = false;
324 rc->backoff_deadline = TIME_MIN;
326 state_transition(rc, S_VOID);
330 /* Disconnects 'rc' and frees the underlying storage. */
332 rconn_destroy(struct rconn *rc)
339 vconn_close(rc->vconn);
341 ofpbuf_list_delete(&rc->txq);
342 for (i = 0; i < rc->n_monitors; i++) {
343 vconn_close(rc->monitors[i]);
350 timeout_VOID(const struct rconn *rc OVS_UNUSED)
356 run_VOID(struct rconn *rc OVS_UNUSED)
362 reconnect(struct rconn *rc)
366 if (rconn_logging_connection_attempts__(rc)) {
367 VLOG_INFO("%s: connecting...", rc->name);
369 rc->n_attempted_connections++;
370 retval = vconn_open(rc->target, rc->allowed_versions,
371 &rc->vconn, rc->dscp);
373 rc->remote_ip = vconn_get_remote_ip(rc->vconn);
374 rc->local_ip = vconn_get_local_ip(rc->vconn);
375 rc->remote_port = vconn_get_remote_port(rc->vconn);
376 rc->backoff_deadline = time_now() + rc->backoff;
377 state_transition(rc, S_CONNECTING);
379 VLOG_WARN("%s: connection failed (%s)", rc->name, strerror(retval));
380 rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
381 disconnect(rc, retval);
386 timeout_BACKOFF(const struct rconn *rc)
392 run_BACKOFF(struct rconn *rc)
400 timeout_CONNECTING(const struct rconn *rc)
402 return MAX(1, rc->backoff);
406 run_CONNECTING(struct rconn *rc)
408 int retval = vconn_connect(rc->vconn);
410 VLOG_INFO("%s: connected", rc->name);
411 rc->n_successful_connections++;
412 state_transition(rc, S_ACTIVE);
413 rc->last_connected = rc->state_entered;
414 } else if (retval != EAGAIN) {
415 if (rconn_logging_connection_attempts__(rc)) {
416 VLOG_INFO("%s: connection failed (%s)",
417 rc->name, strerror(retval));
419 disconnect(rc, retval);
420 } else if (timed_out(rc)) {
421 if (rconn_logging_connection_attempts__(rc)) {
422 VLOG_INFO("%s: connection timed out", rc->name);
424 rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
425 disconnect(rc, ETIMEDOUT);
430 do_tx_work(struct rconn *rc)
432 if (list_is_empty(&rc->txq)) {
435 while (!list_is_empty(&rc->txq)) {
436 int error = try_send(rc);
440 rc->last_activity = time_now();
442 if (list_is_empty(&rc->txq)) {
443 poll_immediate_wake();
448 timeout_ACTIVE(const struct rconn *rc)
450 if (rc->probe_interval) {
451 unsigned int base = MAX(rc->last_activity, rc->state_entered);
452 unsigned int arg = base + rc->probe_interval - rc->state_entered;
459 run_ACTIVE(struct rconn *rc)
462 unsigned int base = MAX(rc->last_activity, rc->state_entered);
465 VLOG_DBG("%s: idle %u seconds, sending inactivity probe",
466 rc->name, (unsigned int) (time_now() - base));
468 version = rconn_get_version(rc);
469 assert(version >= 0 && version <= 0xff);
471 /* Ordering is important here: rconn_send() can transition to BACKOFF,
472 * and we don't want to transition back to IDLE if so, because then we
473 * can end up queuing a packet with vconn == NULL and then *boom*. */
474 state_transition(rc, S_IDLE);
475 rconn_send(rc, make_echo_request(version), NULL);
483 timeout_IDLE(const struct rconn *rc)
485 return rc->probe_interval;
489 run_IDLE(struct rconn *rc)
492 VLOG_ERR("%s: no response to inactivity probe after %u "
493 "seconds, disconnecting",
494 rc->name, elapsed_in_this_state(rc));
495 disconnect(rc, ETIMEDOUT);
501 /* Performs whatever activities are necessary to maintain 'rc': if 'rc' is
502 * disconnected, attempts to (re)connect, backing off as necessary; if 'rc' is
503 * connected, attempts to send packets in the send queue, if any. */
505 rconn_run(struct rconn *rc)
511 vconn_run(rc->vconn);
513 for (i = 0; i < rc->n_monitors; i++) {
514 vconn_run(rc->monitors[i]);
518 old_state = rc->state;
520 #define STATE(NAME, VALUE) case S_##NAME: run_##NAME(rc); break;
526 } while (rc->state != old_state);
529 /* Causes the next call to poll_block() to wake up when rconn_run() should be
532 rconn_run_wait(struct rconn *rc)
538 vconn_run_wait(rc->vconn);
539 if ((rc->state & (S_ACTIVE | S_IDLE)) && !list_is_empty(&rc->txq)) {
540 vconn_wait(rc->vconn, WAIT_SEND);
543 for (i = 0; i < rc->n_monitors; i++) {
544 vconn_run_wait(rc->monitors[i]);
548 if (timeo != UINT_MAX) {
549 long long int expires = sat_add(rc->state_entered, timeo);
550 poll_timer_wait_until(expires * 1000);
554 /* Attempts to receive a packet from 'rc'. If successful, returns the packet;
555 * otherwise, returns a null pointer. The caller is responsible for freeing
556 * the packet (with ofpbuf_delete()). */
558 rconn_recv(struct rconn *rc)
560 if (rc->state & (S_ACTIVE | S_IDLE)) {
561 struct ofpbuf *buffer;
562 int error = vconn_recv(rc->vconn, &buffer);
564 copy_to_monitor(rc, buffer);
565 if (rc->probably_admitted || is_admitted_msg(buffer)
566 || time_now() - rc->last_connected >= 30) {
567 rc->probably_admitted = true;
568 rc->last_admitted = time_now();
570 rc->last_activity = time_now();
571 rc->packets_received++;
572 if (rc->state == S_IDLE) {
573 state_transition(rc, S_ACTIVE);
576 } else if (error != EAGAIN) {
577 report_error(rc, error);
578 disconnect(rc, error);
584 /* Causes the next call to poll_block() to wake up when a packet may be ready
585 * to be received by vconn_recv() on 'rc'. */
587 rconn_recv_wait(struct rconn *rc)
590 vconn_wait(rc->vconn, WAIT_RECV);
594 /* Sends 'b' on 'rc'. Returns 0 if successful, or ENOTCONN if 'rc' is not
595 * currently connected. Takes ownership of 'b'.
597 * If 'counter' is non-null, then 'counter' will be incremented while the
598 * packet is in flight, then decremented when it has been sent (or discarded
599 * due to disconnection). Because 'b' may be sent (or discarded) before this
600 * function returns, the caller may not be able to observe any change in
603 * There is no rconn_send_wait() function: an rconn has a send queue that it
604 * takes care of sending if you call rconn_run(), which will have the side
605 * effect of waking up poll_block(). */
607 rconn_send(struct rconn *rc, struct ofpbuf *b,
608 struct rconn_packet_counter *counter)
610 if (rconn_is_connected(rc)) {
611 COVERAGE_INC(rconn_queued);
612 copy_to_monitor(rc, b);
613 b->private_p = counter;
615 rconn_packet_counter_inc(counter, b->size);
617 list_push_back(&rc->txq, &b->list_node);
619 /* If the queue was empty before we added 'b', try to send some
620 * packets. (But if the queue had packets in it, it's because the
621 * vconn is backlogged and there's no point in stuffing more into it
622 * now. We'll get back to that in rconn_run().) */
623 if (rc->txq.next == &b->list_node) {
633 /* Sends 'b' on 'rc'. Increments 'counter' while the packet is in flight; it
634 * will be decremented when it has been sent (or discarded due to
635 * disconnection). Returns 0 if successful, EAGAIN if 'counter->n' is already
636 * at least as large as 'queue_limit', or ENOTCONN if 'rc' is not currently
637 * connected. Regardless of return value, 'b' is destroyed.
639 * Because 'b' may be sent (or discarded) before this function returns, the
640 * caller may not be able to observe any change in 'counter'.
642 * There is no rconn_send_wait() function: an rconn has a send queue that it
643 * takes care of sending if you call rconn_run(), which will have the side
644 * effect of waking up poll_block(). */
646 rconn_send_with_limit(struct rconn *rc, struct ofpbuf *b,
647 struct rconn_packet_counter *counter, int queue_limit)
650 retval = (counter->n_packets >= queue_limit
652 : rconn_send(rc, b, counter));
654 COVERAGE_INC(rconn_overflow);
659 /* Returns the total number of packets successfully sent on the underlying
660 * vconn. A packet is not counted as sent while it is still queued in the
661 * rconn, only when it has been successfuly passed to the vconn. */
663 rconn_packets_sent(const struct rconn *rc)
665 return rc->packets_sent;
668 /* Adds 'vconn' to 'rc' as a monitoring connection, to which all messages sent
669 * and received on 'rconn' will be copied. 'rc' takes ownership of 'vconn'. */
671 rconn_add_monitor(struct rconn *rc, struct vconn *vconn)
673 if (rc->n_monitors < ARRAY_SIZE(rc->monitors)) {
674 VLOG_INFO("new monitor connection from %s", vconn_get_name(vconn));
675 rc->monitors[rc->n_monitors++] = vconn;
677 VLOG_DBG("too many monitor connections, discarding %s",
678 vconn_get_name(vconn));
683 /* Returns 'rc''s name. This is a name for human consumption, appropriate for
684 * use in log messages. It is not necessarily a name that may be passed
685 * directly to, e.g., vconn_open(). */
687 rconn_get_name(const struct rconn *rc)
692 /* Sets 'rc''s name to 'new_name'. */
694 rconn_set_name(struct rconn *rc, const char *new_name)
697 rc->name = xstrdup(new_name);
700 /* Returns 'rc''s target. This is intended to be a string that may be passed
701 * directly to, e.g., vconn_open(). */
703 rconn_get_target(const struct rconn *rc)
708 /* Returns true if 'rconn' is connected or in the process of reconnecting,
709 * false if 'rconn' is disconnected and will not reconnect on its own. */
711 rconn_is_alive(const struct rconn *rconn)
713 return rconn->state != S_VOID;
716 /* Returns true if 'rconn' is connected, false otherwise. */
718 rconn_is_connected(const struct rconn *rconn)
720 return is_connected_state(rconn->state);
723 /* Returns true if 'rconn' is connected and thought to have been accepted by
724 * the peer's admission-control policy. */
726 rconn_is_admitted(const struct rconn *rconn)
728 return (rconn_is_connected(rconn)
729 && rconn->last_admitted >= rconn->last_connected);
732 /* Returns 0 if 'rconn' is currently connected and considered to have been
733 * accepted by the peer's admission-control policy, otherwise the number of
734 * seconds since 'rconn' was last in such a state. */
736 rconn_failure_duration(const struct rconn *rconn)
738 return rconn_is_admitted(rconn) ? 0 : time_now() - rconn->last_admitted;
741 /* Returns the IP address of the peer, or 0 if the peer's IP address is not
744 rconn_get_remote_ip(const struct rconn *rconn)
746 return rconn->remote_ip;
749 /* Returns the transport port of the peer, or 0 if the peer's port is not
752 rconn_get_remote_port(const struct rconn *rconn)
754 return rconn->remote_port;
757 /* Returns the IP address used to connect to the peer, or 0 if the
758 * connection is not an IP-based protocol or if its IP address is not
761 rconn_get_local_ip(const struct rconn *rconn)
763 return rconn->local_ip;
766 /* Returns the transport port used to connect to the peer, or 0 if the
767 * connection does not contain a port or if the port is not known. */
769 rconn_get_local_port(const struct rconn *rconn)
771 return rconn->vconn ? vconn_get_local_port(rconn->vconn) : 0;
774 /* Returns the OpenFlow version negotiated with the peer, or -1 if there is
775 * currently no connection or if version negotiation is not yet complete. */
777 rconn_get_version(const struct rconn *rconn)
779 return rconn->vconn ? vconn_get_version(rconn->vconn) : -1;
782 /* Returns the total number of packets successfully received by the underlying
785 rconn_packets_received(const struct rconn *rc)
787 return rc->packets_received;
790 /* Returns a string representing the internal state of 'rc'. The caller must
791 * not modify or free the string. */
793 rconn_get_state(const struct rconn *rc)
795 return state_name(rc->state);
798 /* Returns the time at which the last successful connection was made by
799 * 'rc'. Returns TIME_MIN if never connected. */
801 rconn_get_last_connection(const struct rconn *rc)
803 return rc->last_connected;
806 /* Returns the time at which 'rc' was last disconnected. Returns TIME_MIN
807 * if never disconnected. */
809 rconn_get_last_disconnect(const struct rconn *rc)
811 return rc->last_disconnected;
814 /* Returns 'rc''s current connection sequence number, a number that changes
815 * every time that 'rconn' connects or disconnects. */
817 rconn_get_connection_seqno(const struct rconn *rc)
822 /* Returns a value that explains why 'rc' last disconnected:
824 * - 0 means that the last disconnection was caused by a call to
825 * rconn_disconnect(), or that 'rc' is new and has not yet completed its
826 * initial connection or connection attempt.
828 * - EOF means that the connection was closed in the normal way by the peer.
830 * - A positive integer is an errno value that represents the error.
833 rconn_get_last_error(const struct rconn *rc)
835 return rc->last_error;
838 /* Returns the number of messages queued for transmission on 'rc'. */
840 rconn_count_txqlen(const struct rconn *rc)
842 return list_size(&rc->txq);
845 struct rconn_packet_counter *
846 rconn_packet_counter_create(void)
848 struct rconn_packet_counter *c = xzalloc(sizeof *c);
854 rconn_packet_counter_destroy(struct rconn_packet_counter *c)
857 assert(c->ref_cnt > 0);
858 if (!--c->ref_cnt && !c->n_packets) {
865 rconn_packet_counter_inc(struct rconn_packet_counter *c, unsigned int n_bytes)
868 c->n_bytes += n_bytes;
872 rconn_packet_counter_dec(struct rconn_packet_counter *c, unsigned int n_bytes)
874 assert(c->n_packets > 0);
875 assert(c->n_bytes >= n_bytes);
877 c->n_bytes -= n_bytes;
887 /* Set rc->target and rc->name to 'target' and 'name', respectively. If 'name'
888 * is null, 'target' is used.
890 * Also, clear out the cached IP address and port information, since changing
891 * the target also likely changes these values. */
893 rconn_set_target__(struct rconn *rc, const char *target, const char *name)
896 rc->name = xstrdup(name ? name : target);
898 rc->target = xstrdup(target);
904 /* Tries to send a packet from 'rc''s send buffer. Returns 0 if successful,
905 * otherwise a positive errno value. */
907 try_send(struct rconn *rc)
909 struct ofpbuf *msg = ofpbuf_from_list(rc->txq.next);
910 unsigned int n_bytes = msg->size;
911 struct rconn_packet_counter *counter = msg->private_p;
914 /* Eagerly remove 'msg' from the txq. We can't remove it from the list
915 * after sending, if sending is successful, because it is then owned by the
916 * vconn, which might have freed it already. */
917 list_remove(&msg->list_node);
919 retval = vconn_send(rc->vconn, msg);
921 list_push_front(&rc->txq, &msg->list_node);
922 if (retval != EAGAIN) {
923 report_error(rc, retval);
924 disconnect(rc, retval);
928 COVERAGE_INC(rconn_sent);
931 rconn_packet_counter_dec(counter, n_bytes);
936 /* Reports that 'error' caused 'rc' to disconnect. 'error' may be a positive
937 * errno value, or it may be EOF to indicate that the connection was closed
940 report_error(struct rconn *rc, int error)
943 /* If 'rc' isn't reliable, then we don't really expect this connection
944 * to last forever anyway (probably it's a connection that we received
945 * via accept()), so use DBG level to avoid cluttering the logs. */
946 enum vlog_level level = rc->reliable ? VLL_INFO : VLL_DBG;
947 VLOG(level, "%s: connection closed by peer", rc->name);
949 VLOG_WARN("%s: connection dropped (%s)", rc->name, strerror(error));
953 /* Disconnects 'rc' and records 'error' as the error that caused 'rc''s last
956 * - 0 means that this disconnection is due to a request by 'rc''s client,
957 * not due to any kind of network error.
959 * - EOF means that the connection was closed in the normal way by the peer.
961 * - A positive integer is an errno value that represents the error.
964 disconnect(struct rconn *rc, int error)
966 rc->last_error = error;
968 time_t now = time_now();
970 if (rc->state & (S_CONNECTING | S_ACTIVE | S_IDLE)) {
971 rc->last_disconnected = now;
972 vconn_close(rc->vconn);
977 if (now >= rc->backoff_deadline) {
979 } else if (rc->backoff < rc->max_backoff / 2) {
980 rc->backoff = MAX(1, 2 * rc->backoff);
981 VLOG_INFO("%s: waiting %d seconds before reconnect",
982 rc->name, rc->backoff);
984 if (rconn_logging_connection_attempts__(rc)) {
985 VLOG_INFO("%s: continuing to retry connections in the "
986 "background but suppressing further logging",
989 rc->backoff = rc->max_backoff;
991 rc->backoff_deadline = now + rc->backoff;
992 state_transition(rc, S_BACKOFF);
994 rc->last_disconnected = time_now();
995 rconn_disconnect(rc);
999 /* Drops all the packets from 'rc''s send queue and decrements their queue
1002 flush_queue(struct rconn *rc)
1004 if (list_is_empty(&rc->txq)) {
1007 while (!list_is_empty(&rc->txq)) {
1008 struct ofpbuf *b = ofpbuf_from_list(list_pop_front(&rc->txq));
1009 struct rconn_packet_counter *counter = b->private_p;
1011 rconn_packet_counter_dec(counter, b->size);
1013 COVERAGE_INC(rconn_discarded);
1016 poll_immediate_wake();
1020 elapsed_in_this_state(const struct rconn *rc)
1022 return time_now() - rc->state_entered;
1026 timeout(const struct rconn *rc)
1028 switch (rc->state) {
1029 #define STATE(NAME, VALUE) case S_##NAME: return timeout_##NAME(rc);
1038 timed_out(const struct rconn *rc)
1040 return time_now() >= sat_add(rc->state_entered, timeout(rc));
1044 state_transition(struct rconn *rc, enum state state)
1046 rc->seqno += (rc->state == S_ACTIVE) != (state == S_ACTIVE);
1047 if (is_connected_state(state) && !is_connected_state(rc->state)) {
1048 rc->probably_admitted = false;
1050 if (rconn_is_connected(rc)) {
1051 rc->total_time_connected += elapsed_in_this_state(rc);
1053 VLOG_DBG("%s: entering %s", rc->name, state_name(state));
1055 rc->state_entered = time_now();
1059 copy_to_monitor(struct rconn *rc, const struct ofpbuf *b)
1061 struct ofpbuf *clone = NULL;
1065 for (i = 0; i < rc->n_monitors; ) {
1066 struct vconn *vconn = rc->monitors[i];
1069 clone = ofpbuf_clone(b);
1071 retval = vconn_send(vconn, clone);
1074 } else if (retval != EAGAIN) {
1075 VLOG_DBG("%s: closing monitor connection to %s: %s",
1076 rconn_get_name(rc), vconn_get_name(vconn),
1078 rc->monitors[i] = rc->monitors[--rc->n_monitors];
1083 ofpbuf_delete(clone);
1087 is_connected_state(enum state state)
1089 return (state & (S_ACTIVE | S_IDLE)) != 0;
1093 is_admitted_msg(const struct ofpbuf *b)
1098 error = ofptype_decode(&type, b->data);
1106 case OFPTYPE_ECHO_REQUEST:
1107 case OFPTYPE_ECHO_REPLY:
1108 case OFPTYPE_FEATURES_REQUEST:
1109 case OFPTYPE_FEATURES_REPLY:
1110 case OFPTYPE_GET_CONFIG_REQUEST:
1111 case OFPTYPE_GET_CONFIG_REPLY:
1112 case OFPTYPE_SET_CONFIG:
1115 case OFPTYPE_PACKET_IN:
1116 case OFPTYPE_FLOW_REMOVED:
1117 case OFPTYPE_PORT_STATUS:
1118 case OFPTYPE_PACKET_OUT:
1119 case OFPTYPE_FLOW_MOD:
1120 case OFPTYPE_PORT_MOD:
1121 case OFPTYPE_BARRIER_REQUEST:
1122 case OFPTYPE_BARRIER_REPLY:
1123 case OFPTYPE_DESC_STATS_REQUEST:
1124 case OFPTYPE_DESC_STATS_REPLY:
1125 case OFPTYPE_FLOW_STATS_REQUEST:
1126 case OFPTYPE_FLOW_STATS_REPLY:
1127 case OFPTYPE_AGGREGATE_STATS_REQUEST:
1128 case OFPTYPE_AGGREGATE_STATS_REPLY:
1129 case OFPTYPE_TABLE_STATS_REQUEST:
1130 case OFPTYPE_TABLE_STATS_REPLY:
1131 case OFPTYPE_PORT_STATS_REQUEST:
1132 case OFPTYPE_PORT_STATS_REPLY:
1133 case OFPTYPE_QUEUE_STATS_REQUEST:
1134 case OFPTYPE_QUEUE_STATS_REPLY:
1135 case OFPTYPE_PORT_DESC_STATS_REQUEST:
1136 case OFPTYPE_PORT_DESC_STATS_REPLY:
1137 case OFPTYPE_ROLE_REQUEST:
1138 case OFPTYPE_ROLE_REPLY:
1139 case OFPTYPE_SET_FLOW_FORMAT:
1140 case OFPTYPE_FLOW_MOD_TABLE_ID:
1141 case OFPTYPE_SET_PACKET_IN_FORMAT:
1142 case OFPTYPE_FLOW_AGE:
1143 case OFPTYPE_SET_ASYNC_CONFIG:
1144 case OFPTYPE_SET_CONTROLLER_ID:
1145 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
1146 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
1147 case OFPTYPE_FLOW_MONITOR_CANCEL:
1148 case OFPTYPE_FLOW_MONITOR_PAUSED:
1149 case OFPTYPE_FLOW_MONITOR_RESUMED:
1155 /* Returns true if 'rc' is currently logging information about connection
1156 * attempts, false if logging should be suppressed because 'rc' hasn't
1157 * successuflly connected in too long. */
1159 rconn_logging_connection_attempts__(const struct rconn *rc)
1161 return rc->backoff < rc->max_backoff;