2 * Copyright (c) 2008, 2009, 2010 Nicira Networks.
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 "reconnect.h"
23 #include "poll-loop.h"
26 VLOG_DEFINE_THIS_MODULE(reconnect)
30 STATE(BACKOFF, 1 << 1) \
31 STATE(CONNECT_IN_PROGRESS, 1 << 3) \
32 STATE(ACTIVE, 1 << 4) \
34 STATE(RECONNECT, 1 << 6) \
35 STATE(LISTENING, 1 << 7)
37 #define STATE(NAME, VALUE) S_##NAME = VALUE,
43 is_connected_state(enum state state)
45 return (state & (S_ACTIVE | S_IDLE)) != 0;
55 enum vlog_level info; /* Used for informational messages. */
59 long long int state_entered;
61 long long int last_received;
62 long long int last_connected;
63 unsigned int max_tries;
65 /* These values are simply for statistics reporting, not otherwise used
66 * directly by anything internal. */
67 long long int creation_time;
68 unsigned int n_attempted_connections, n_successful_connections;
69 unsigned int total_connected_duration;
73 static void reconnect_transition__(struct reconnect *, long long int now,
75 static long long int reconnect_deadline__(const struct reconnect *);
76 static bool reconnect_may_retry(struct reconnect *);
79 reconnect_state_name__(enum state state)
82 #define STATE(NAME, VALUE) case S_##NAME: return #NAME;
89 /* Creates and returns a new reconnect FSM with default settings. The FSM is
90 * initially disabled. The caller will likely want to call reconnect_enable()
91 * and reconnect_set_name() on the returned object. */
93 reconnect_create(long long int now)
95 struct reconnect *fsm = xzalloc(sizeof *fsm);
97 fsm->name = xstrdup("void");
98 fsm->min_backoff = 1000;
99 fsm->max_backoff = 8000;
100 fsm->probe_interval = 5000;
101 fsm->passive = false;
102 fsm->info = VLL_INFO;
105 fsm->state_entered = now;
107 fsm->last_received = now;
108 fsm->last_connected = now;
109 fsm->max_tries = UINT_MAX;
110 fsm->creation_time = now;
117 reconnect_destroy(struct reconnect *fsm)
125 /* If 'quiet' is true, 'fsm' will log informational messages at level VLL_DBG,
126 * by default keeping them out of log files. This is appropriate if the
127 * connection is one that is expected to be short-lived, so that the log
128 * messages are merely distracting.
130 * If 'quiet' is false, 'fsm' logs informational messages at level VLL_INFO.
131 * This is the default.
133 * This setting has no effect on the log level of debugging, warning, or error
136 reconnect_set_quiet(struct reconnect *fsm, bool quiet)
138 fsm->info = quiet ? VLL_DBG : VLL_INFO;
141 /* Returns 'fsm''s name. */
143 reconnect_get_name(const struct reconnect *fsm)
148 /* Sets 'fsm''s name to 'name'. If 'name' is null, then "void" is used
151 * The name set for 'fsm' is used in log messages. */
153 reconnect_set_name(struct reconnect *fsm, const char *name)
156 fsm->name = xstrdup(name ? name : "void");
159 /* Return the minimum number of milliseconds to back off between consecutive
160 * connection attempts. The default is 1000 ms. */
162 reconnect_get_min_backoff(const struct reconnect *fsm)
164 return fsm->min_backoff;
167 /* Return the maximum number of milliseconds to back off between consecutive
168 * connection attempts. The default is 8000 ms. */
170 reconnect_get_max_backoff(const struct reconnect *fsm)
172 return fsm->max_backoff;
175 /* Returns the "probe interval" for 'fsm' in milliseconds. If this is zero, it
176 * disables the connection keepalive feature. If it is nonzero, then if the
177 * interval passes while 'fsm' is connected and without reconnect_received()
178 * being called for 'fsm', reconnect_run() returns RECONNECT_PROBE. If the
179 * interval passes again without reconnect_received() being called,
180 * reconnect_run() returns RECONNECT_DISCONNECT for 'fsm'. */
182 reconnect_get_probe_interval(const struct reconnect *fsm)
184 return fsm->probe_interval;
187 /* Limits the maximum number of times that 'fsm' will ask the client to try to
188 * reconnect to 'max_tries'. UINT_MAX (the default) means an unlimited number
191 * After the number of tries has expired, the 'fsm' will disable itself
192 * instead of backing off and retrying. */
194 reconnect_set_max_tries(struct reconnect *fsm, unsigned int max_tries)
196 fsm->max_tries = max_tries;
199 /* Returns the current remaining number of connection attempts, UINT_MAX if
200 * the number is unlimited. */
202 reconnect_get_max_tries(struct reconnect *fsm)
204 return fsm->max_tries;
207 /* Configures the backoff parameters for 'fsm'. 'min_backoff' is the minimum
208 * number of milliseconds, and 'max_backoff' is the maximum, between connection
211 * 'min_backoff' must be at least 1000, and 'max_backoff' must be greater than
212 * or equal to 'min_backoff'. */
214 reconnect_set_backoff(struct reconnect *fsm, int min_backoff, int max_backoff)
216 fsm->min_backoff = MAX(min_backoff, 1000);
217 fsm->max_backoff = max_backoff ? MAX(max_backoff, 1000) : 8000;
218 if (fsm->min_backoff > fsm->max_backoff) {
219 fsm->max_backoff = fsm->min_backoff;
222 if (fsm->state == S_BACKOFF && fsm->backoff > max_backoff) {
223 fsm->backoff = max_backoff;
227 /* Sets the "probe interval" for 'fsm' to 'probe_interval', in milliseconds.
228 * If this is zero, it disables the connection keepalive feature. If it is
229 * nonzero, then if the interval passes while 'fsm' is connected and without
230 * reconnect_received() being called for 'fsm', reconnect_run() returns
231 * RECONNECT_PROBE. If the interval passes again without reconnect_received()
232 * being called, reconnect_run() returns RECONNECT_DISCONNECT for 'fsm'.
234 * If 'probe_interval' is nonzero, then it will be forced to a value of at
237 reconnect_set_probe_interval(struct reconnect *fsm, int probe_interval)
239 fsm->probe_interval = probe_interval ? MAX(1000, probe_interval) : 0;
242 /* Returns true if 'fsm' is in passive mode, false if 'fsm' is in active mode
245 reconnect_is_passive(const struct reconnect *fsm)
250 /* Configures 'fsm' for active or passive mode. In active mode (the default),
251 * the FSM is attempting to connect to a remote host. In passive mode, the FSM
252 * is listening for connections from a remote host. */
254 reconnect_set_passive(struct reconnect *fsm, bool passive, long long int now)
256 if (fsm->passive != passive) {
257 fsm->passive = passive;
260 ? fsm->state & (S_CONNECT_IN_PROGRESS | S_RECONNECT)
261 : fsm->state == S_LISTENING && reconnect_may_retry(fsm)) {
262 reconnect_transition__(fsm, now, S_BACKOFF);
268 /* Returns true if 'fsm' has been enabled with reconnect_enable(). Calling
269 * another function that indicates a change in connection state, such as
270 * reconnect_disconnected() or reconnect_force_reconnect(), will also enable
271 * a reconnect FSM. */
273 reconnect_is_enabled(const struct reconnect *fsm)
275 return fsm->state != S_VOID;
278 /* If 'fsm' is disabled (the default for newly created FSMs), enables it, so
279 * that the next call to reconnect_run() for 'fsm' will return
282 * If 'fsm' is not disabled, this function has no effect. */
284 reconnect_enable(struct reconnect *fsm, long long int now)
286 if (fsm->state == S_VOID && reconnect_may_retry(fsm)) {
287 reconnect_transition__(fsm, now, S_BACKOFF);
292 /* Disables 'fsm'. Until 'fsm' is enabled again, reconnect_run() will always
295 reconnect_disable(struct reconnect *fsm, long long int now)
297 if (fsm->state != S_VOID) {
298 reconnect_transition__(fsm, now, S_VOID);
302 /* If 'fsm' is enabled and currently connected (or attempting to connect),
303 * forces reconnect_run() for 'fsm' to return RECONNECT_DISCONNECT the next
304 * time it is called, which should cause the client to drop the connection (or
305 * attempt), back off, and then reconnect. */
307 reconnect_force_reconnect(struct reconnect *fsm, long long int now)
309 if (fsm->state & (S_CONNECT_IN_PROGRESS | S_ACTIVE | S_IDLE)) {
310 reconnect_transition__(fsm, now, S_RECONNECT);
314 /* Tell 'fsm' that the connection dropped or that a connection attempt failed.
315 * 'error' specifies the reason: a positive value represents an errno value,
316 * EOF indicates that the connection was closed by the peer (e.g. read()
317 * returned 0), and 0 indicates no specific error.
319 * The FSM will back off, then reconnect. */
321 reconnect_disconnected(struct reconnect *fsm, long long int now, int error)
323 if (!(fsm->state & (S_BACKOFF | S_VOID))) {
324 /* Report what happened. */
325 if (fsm->state & (S_ACTIVE | S_IDLE)) {
327 VLOG_WARN("%s: connection dropped (%s)",
328 fsm->name, strerror(error));
329 } else if (error == EOF) {
330 VLOG(fsm->info, "%s: connection closed by peer", fsm->name);
332 VLOG(fsm->info, "%s: connection dropped", fsm->name);
334 } else if (fsm->state == S_LISTENING) {
336 VLOG_WARN("%s: error listening for connections (%s)",
337 fsm->name, strerror(error));
339 VLOG(fsm->info, "%s: error listening for connections",
343 const char *type = fsm->passive ? "listen" : "connection";
345 VLOG_WARN("%s: %s attempt failed (%s)",
346 fsm->name, type, strerror(error));
348 VLOG(fsm->info, "%s: %s attempt timed out", fsm->name, type);
353 if (fsm->state & (S_ACTIVE | S_IDLE)
354 && (fsm->last_received - fsm->last_connected >= fsm->backoff
356 fsm->backoff = fsm->passive ? 0 : fsm->min_backoff;
358 if (fsm->backoff < fsm->min_backoff) {
359 fsm->backoff = fsm->min_backoff;
360 } else if (fsm->backoff >= fsm->max_backoff / 2) {
361 fsm->backoff = fsm->max_backoff;
366 VLOG(fsm->info, "%s: waiting %.3g seconds before trying to "
367 "listen again", fsm->name, fsm->backoff / 1000.0);
369 VLOG(fsm->info, "%s: waiting %.3g seconds before reconnect",
370 fsm->name, fsm->backoff / 1000.0);
374 reconnect_transition__(fsm, now,
375 reconnect_may_retry(fsm) ? S_BACKOFF : S_VOID);
379 /* Tell 'fsm' that a connection or listening attempt is in progress.
381 * The FSM will start a timer, after which the connection or listening attempt
382 * will be aborted (by returning RECONNECT_DISCONNECT from
383 * reconnect_run()). */
385 reconnect_connecting(struct reconnect *fsm, long long int now)
387 if (fsm->state != S_CONNECT_IN_PROGRESS) {
389 VLOG(fsm->info, "%s: listening...", fsm->name);
391 VLOG(fsm->info, "%s: connecting...", fsm->name);
393 reconnect_transition__(fsm, now, S_CONNECT_IN_PROGRESS);
397 /* Tell 'fsm' that the client is listening for connection attempts. This state
398 * last indefinitely until the client reports some change.
400 * The natural progression from this state is for the client to report that a
401 * connection has been accepted or is in progress of being accepted, by calling
402 * reconnect_connecting() or reconnect_connected().
404 * The client may also report that listening failed (e.g. accept() returned an
405 * unexpected error such as ENOMEM) by calling reconnect_listen_error(), in
406 * which case the FSM will back off and eventually return RECONNECT_CONNECT
407 * from reconnect_run() to tell the client to try listening again. */
409 reconnect_listening(struct reconnect *fsm, long long int now)
411 if (fsm->state != S_LISTENING) {
412 VLOG(fsm->info, "%s: listening...", fsm->name);
413 reconnect_transition__(fsm, now, S_LISTENING);
417 /* Tell 'fsm' that the client's attempt to accept a connection failed
418 * (e.g. accept() returned an unexpected error such as ENOMEM).
420 * If the FSM is currently listening (reconnect_listening() was called), it
421 * will back off and eventually return RECONNECT_CONNECT from reconnect_run()
422 * to tell the client to try listening again. If there is an active
423 * connection, this will be delayed until that connection drops. */
425 reconnect_listen_error(struct reconnect *fsm, long long int now, int error)
427 if (fsm->state == S_LISTENING) {
428 reconnect_disconnected(fsm, now, error);
432 /* Tell 'fsm' that the connection was successful.
434 * The FSM will start the probe interval timer, which is reset by
435 * reconnect_received(). If the timer expires, a probe will be sent (by
436 * returning RECONNECT_PROBE from reconnect_run()). If the timer expires
437 * again without being reset, the connection will be aborted (by returning
438 * RECONNECT_DISCONNECT from reconnect_run()). */
440 reconnect_connected(struct reconnect *fsm, long long int now)
442 if (!is_connected_state(fsm->state)) {
443 reconnect_connecting(fsm, now);
445 VLOG(fsm->info, "%s: connected", fsm->name);
446 reconnect_transition__(fsm, now, S_ACTIVE);
447 fsm->last_connected = now;
451 /* Tell 'fsm' that the connection attempt failed.
453 * The FSM will back off and attempt to reconnect. */
455 reconnect_connect_failed(struct reconnect *fsm, long long int now, int error)
457 reconnect_connecting(fsm, now);
458 reconnect_disconnected(fsm, now, error);
461 /* Tell 'fsm' that some data was received. This resets the probe interval
462 * timer, so that the connection is known not to be idle. */
464 reconnect_received(struct reconnect *fsm, long long int now)
466 if (fsm->state != S_ACTIVE) {
467 reconnect_transition__(fsm, now, S_ACTIVE);
469 fsm->last_received = now;
473 reconnect_transition__(struct reconnect *fsm, long long int now,
476 if (fsm->state == S_CONNECT_IN_PROGRESS) {
477 fsm->n_attempted_connections++;
478 if (state == S_ACTIVE) {
479 fsm->n_successful_connections++;
482 if (is_connected_state(fsm->state) != is_connected_state(state)) {
483 if (is_connected_state(fsm->state)) {
484 fsm->total_connected_duration += now - fsm->last_connected;
489 VLOG_DBG("%s: entering %s", fsm->name, reconnect_state_name__(state));
491 fsm->state_entered = now;
495 reconnect_deadline__(const struct reconnect *fsm)
497 assert(fsm->state_entered != LLONG_MIN);
498 switch (fsm->state) {
504 return fsm->state_entered + fsm->backoff;
506 case S_CONNECT_IN_PROGRESS:
507 return fsm->state_entered + MAX(1000, fsm->backoff);
510 if (fsm->probe_interval) {
511 long long int base = MAX(fsm->last_received, fsm->state_entered);
512 return base + fsm->probe_interval;
517 return fsm->state_entered + fsm->probe_interval;
520 return fsm->state_entered;
526 /* Assesses whether any action should be taken on 'fsm'. The return value is
529 * - 0: The client need not take any action.
531 * - Active client, RECONNECT_CONNECT: The client should start a connection
532 * attempt and indicate this by calling reconnect_connecting(). If the
533 * connection attempt has definitely succeeded, it should call
534 * reconnect_connected(). If the connection attempt has definitely
535 * failed, it should call reconnect_connect_failed().
537 * The FSM is smart enough to back off correctly after successful
538 * connections that quickly abort, so it is OK to call
539 * reconnect_connected() after a low-level successful connection
540 * (e.g. connect()) even if the connection might soon abort due to a
541 * failure at a high-level (e.g. SSL negotiation failure).
543 * - Passive client, RECONNECT_CONNECT: The client should try to listen for
544 * a connection, if it is not already listening. It should call
545 * reconnect_listening() if successful, otherwise reconnect_connecting()
546 * or reconnected_connect_failed() if the attempt is in progress or
547 * definitely failed, respectively.
549 * A listening passive client should constantly attempt to accept a new
550 * connection and report an accepted connection with
551 * reconnect_connected().
553 * - RECONNECT_DISCONNECT: The client should abort the current connection
554 * or connection attempt or listen attempt and call
555 * reconnect_disconnected() or reconnect_connect_failed() to indicate it.
557 * - RECONNECT_PROBE: The client should send some kind of request to the
558 * peer that will elicit a response, to ensure that the connection is
559 * indeed in working order. (This will only be returned if the "probe
560 * interval" is nonzero--see reconnect_set_probe_interval()).
562 enum reconnect_action
563 reconnect_run(struct reconnect *fsm, long long int now)
565 if (now >= reconnect_deadline__(fsm)) {
566 switch (fsm->state) {
571 return RECONNECT_CONNECT;
573 case S_CONNECT_IN_PROGRESS:
574 return RECONNECT_DISCONNECT;
577 VLOG_DBG("%s: idle %lld ms, sending inactivity probe", fsm->name,
578 now - MAX(fsm->last_received, fsm->state_entered));
579 reconnect_transition__(fsm, now, S_IDLE);
580 return RECONNECT_PROBE;
583 VLOG_ERR("%s: no response to inactivity probe after %.3g "
584 "seconds, disconnecting",
585 fsm->name, (now - fsm->state_entered) / 1000.0);
586 return RECONNECT_DISCONNECT;
589 return RECONNECT_DISCONNECT;
601 /* Causes the next call to poll_block() to wake up when reconnect_run() should
602 * be called on 'fsm'. */
604 reconnect_wait(struct reconnect *fsm, long long int now)
606 int timeout = reconnect_timeout(fsm, now);
608 poll_timer_wait(timeout);
612 /* Returns the number of milliseconds after which reconnect_run() should be
613 * called on 'fsm' if nothing else notable happens in the meantime, or a
614 * negative number if this is currently unnecessary. */
616 reconnect_timeout(struct reconnect *fsm, long long int now)
618 long long int deadline = reconnect_deadline__(fsm);
619 if (deadline != LLONG_MAX) {
620 long long int remaining = deadline - now;
621 return MAX(0, MIN(INT_MAX, remaining));
626 /* Returns true if 'fsm' is currently believed to be connected, that is, if
627 * reconnect_connected() was called more recently than any call to
628 * reconnect_connect_failed() or reconnect_disconnected() or
629 * reconnect_disable(), and false otherwise. */
631 reconnect_is_connected(const struct reconnect *fsm)
633 return is_connected_state(fsm->state);
636 /* Returns the number of milliseconds for which 'fsm' has been continuously
637 * connected to its peer. (If 'fsm' is not currently connected, this is 0.) */
639 reconnect_get_connection_duration(const struct reconnect *fsm,
642 return reconnect_is_connected(fsm) ? now - fsm->last_connected : 0;
645 /* Copies various statistics for 'fsm' into '*stats'. */
647 reconnect_get_stats(const struct reconnect *fsm, long long int now,
648 struct reconnect_stats *stats)
650 stats->creation_time = fsm->creation_time;
651 stats->last_received = fsm->last_received;
652 stats->last_connected = fsm->last_connected;
653 stats->backoff = fsm->backoff;
654 stats->seqno = fsm->seqno;
655 stats->is_connected = reconnect_is_connected(fsm);
656 stats->current_connection_duration
657 = reconnect_get_connection_duration(fsm, now);
658 stats->total_connected_duration = (stats->current_connection_duration
659 + fsm->total_connected_duration);
660 stats->n_attempted_connections = fsm->n_attempted_connections;
661 stats->n_successful_connections = fsm->n_successful_connections;
662 stats->state = reconnect_state_name__(fsm->state);
663 stats->state_elapsed = now - fsm->state_entered;
667 reconnect_may_retry(struct reconnect *fsm)
669 bool may_retry = fsm->max_tries > 0;
670 if (may_retry && fsm->max_tries != UINT_MAX) {