daemon: Integrate checking for an existing pidfile into daemonize_start().
[sliver-openvswitch.git] / lib / rconn.c
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #include <config.h>
18 #include "rconn.h"
19 #include <assert.h>
20 #include <errno.h>
21 #include <limits.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include "coverage.h"
25 #include "ofp-util.h"
26 #include "ofpbuf.h"
27 #include "openflow/openflow.h"
28 #include "poll-loop.h"
29 #include "sat-math.h"
30 #include "timeval.h"
31 #include "util.h"
32 #include "vconn.h"
33 #include "vlog.h"
34
35 VLOG_DEFINE_THIS_MODULE(rconn);
36
37 COVERAGE_DEFINE(rconn_discarded);
38 COVERAGE_DEFINE(rconn_overflow);
39 COVERAGE_DEFINE(rconn_queued);
40 COVERAGE_DEFINE(rconn_sent);
41
42 #define STATES                                  \
43     STATE(VOID, 1 << 0)                         \
44     STATE(BACKOFF, 1 << 1)                      \
45     STATE(CONNECTING, 1 << 2)                   \
46     STATE(ACTIVE, 1 << 3)                       \
47     STATE(IDLE, 1 << 4)
48 enum state {
49 #define STATE(NAME, VALUE) S_##NAME = VALUE,
50     STATES
51 #undef STATE
52 };
53
54 static const char *
55 state_name(enum state state)
56 {
57     switch (state) {
58 #define STATE(NAME, VALUE) case S_##NAME: return #NAME;
59         STATES
60 #undef STATE
61     }
62     return "***ERROR***";
63 }
64
65 /* A reliable connection to an OpenFlow switch or controller.
66  *
67  * See the large comment in rconn.h for more information. */
68 struct rconn {
69     enum state state;
70     time_t state_entered;
71
72     struct vconn *vconn;
73     char *name;                 /* Human-readable descriptive name. */
74     char *target;               /* vconn name, passed to vconn_open(). */
75     bool reliable;
76
77     struct list txq;            /* Contains "struct ofpbuf"s. */
78
79     int backoff;
80     int max_backoff;
81     time_t backoff_deadline;
82     time_t last_received;
83     time_t last_connected;
84     time_t last_disconnected;
85     unsigned int packets_sent;
86     unsigned int seqno;
87     int last_error;
88
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.
94      *
95      * last_admitted reports the last time we believe such a positive admission
96      * control decision was made. */
97     bool probably_admitted;
98     time_t last_admitted;
99
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;
106
107     /* Throughout this file, "probe" is shorthand for "inactivity probe".
108      * When nothing has been received from the peer for a while, we send out
109      * an echo request as an inactivity probe packet.  We should receive back
110      * a response. */
111     int probe_interval;         /* Secs of inactivity before sending probe. */
112
113     /* When we create a vconn we obtain these values, to save them past the end
114      * of the vconn's lifetime.  Otherwise, in-band control will only allow
115      * traffic when a vconn is actually open, but it is nice to allow ARP to
116      * complete even between connection attempts, and it is also polite to
117      * allow traffic from other switches to go through to the controller
118      * whether or not we are connected.
119      *
120      * We don't cache the local port, because that changes from one connection
121      * attempt to the next. */
122     uint32_t local_ip, remote_ip;
123     uint16_t remote_port;
124
125     /* Messages sent or received are copied to the monitor connections. */
126 #define MAX_MONITORS 8
127     struct vconn *monitors[8];
128     size_t n_monitors;
129 };
130
131 static unsigned int elapsed_in_this_state(const struct rconn *);
132 static unsigned int timeout(const struct rconn *);
133 static bool timed_out(const struct rconn *);
134 static void state_transition(struct rconn *, enum state);
135 static void rconn_set_target__(struct rconn *,
136                                const char *target, const char *name);
137 static int try_send(struct rconn *);
138 static void reconnect(struct rconn *);
139 static void report_error(struct rconn *, int error);
140 static void disconnect(struct rconn *, int error);
141 static void flush_queue(struct rconn *);
142 static void copy_to_monitor(struct rconn *, const struct ofpbuf *);
143 static bool is_connected_state(enum state);
144 static bool is_admitted_msg(const struct ofpbuf *);
145 static bool rconn_logging_connection_attempts__(const struct rconn *);
146
147 /* Creates and returns a new rconn.
148  *
149  * 'probe_interval' is a number of seconds.  If the interval passes once
150  * without an OpenFlow message being received from the peer, the rconn sends
151  * out an "echo request" message.  If the interval passes again without a
152  * message being received, the rconn disconnects and re-connects to the peer.
153  * Setting 'probe_interval' to 0 disables this behavior.
154  *
155  * 'max_backoff' is the maximum number of seconds between attempts to connect
156  * to the peer.  The actual interval starts at 1 second and doubles on each
157  * failure until it reaches 'max_backoff'.  If 0 is specified, the default of
158  * 8 seconds is used.
159  *
160  * The new rconn is initially unconnected.  Use rconn_connect() or
161  * rconn_connect_unreliably() to connect it. */
162 struct rconn *
163 rconn_create(int probe_interval, int max_backoff)
164 {
165     struct rconn *rc = xzalloc(sizeof *rc);
166
167     rc->state = S_VOID;
168     rc->state_entered = time_now();
169
170     rc->vconn = NULL;
171     rc->name = xstrdup("void");
172     rc->target = xstrdup("void");
173     rc->reliable = false;
174
175     list_init(&rc->txq);
176
177     rc->backoff = 0;
178     rc->max_backoff = max_backoff ? max_backoff : 8;
179     rc->backoff_deadline = TIME_MIN;
180     rc->last_received = time_now();
181     rc->last_connected = TIME_MIN;
182     rc->last_disconnected = TIME_MIN;
183     rc->seqno = 0;
184
185     rc->packets_sent = 0;
186
187     rc->probably_admitted = false;
188     rc->last_admitted = time_now();
189
190     rc->packets_received = 0;
191     rc->n_attempted_connections = 0;
192     rc->n_successful_connections = 0;
193     rc->creation_time = time_now();
194     rc->total_time_connected = 0;
195
196     rconn_set_probe_interval(rc, probe_interval);
197
198     rc->n_monitors = 0;
199
200     return rc;
201 }
202
203 void
204 rconn_set_max_backoff(struct rconn *rc, int max_backoff)
205 {
206     rc->max_backoff = MAX(1, max_backoff);
207     if (rc->state == S_BACKOFF && rc->backoff > max_backoff) {
208         rc->backoff = max_backoff;
209         if (rc->backoff_deadline > time_now() + max_backoff) {
210             rc->backoff_deadline = time_now() + max_backoff;
211         }
212     }
213 }
214
215 int
216 rconn_get_max_backoff(const struct rconn *rc)
217 {
218     return rc->max_backoff;
219 }
220
221 void
222 rconn_set_probe_interval(struct rconn *rc, int probe_interval)
223 {
224     rc->probe_interval = probe_interval ? MAX(5, probe_interval) : 0;
225 }
226
227 int
228 rconn_get_probe_interval(const struct rconn *rc)
229 {
230     return rc->probe_interval;
231 }
232
233 /* Drops any existing connection on 'rc', then sets up 'rc' to connect to
234  * 'target' and reconnect as needed.  'target' should be a remote OpenFlow
235  * target in a form acceptable to vconn_open().
236  *
237  * If 'name' is nonnull, then it is used in log messages in place of 'target'.
238  * It should presumably give more information to a human reader than 'target',
239  * but it need not be acceptable to vconn_open(). */
240 void
241 rconn_connect(struct rconn *rc, const char *target, const char *name)
242 {
243     rconn_disconnect(rc);
244     rconn_set_target__(rc, target, name);
245     rc->reliable = true;
246     reconnect(rc);
247 }
248
249 /* Drops any existing connection on 'rc', then configures 'rc' to use
250  * 'vconn'.  If the connection on 'vconn' drops, 'rc' will not reconnect on it
251  * own.
252  *
253  * By default, the target obtained from vconn_get_name(vconn) is used in log
254  * messages.  If 'name' is nonnull, then it is used instead.  It should
255  * presumably give more information to a human reader than the target, but it
256  * need not be acceptable to vconn_open(). */
257 void
258 rconn_connect_unreliably(struct rconn *rc,
259                          struct vconn *vconn, const char *name)
260 {
261     assert(vconn != NULL);
262     rconn_disconnect(rc);
263     rconn_set_target__(rc, vconn_get_name(vconn), name);
264     rc->reliable = false;
265     rc->vconn = vconn;
266     rc->last_connected = time_now();
267     state_transition(rc, S_ACTIVE);
268 }
269
270 /* If 'rc' is connected, forces it to drop the connection and reconnect. */
271 void
272 rconn_reconnect(struct rconn *rc)
273 {
274     if (rc->state & (S_ACTIVE | S_IDLE)) {
275         VLOG_INFO("%s: disconnecting", rc->name);
276         disconnect(rc, 0);
277     }
278 }
279
280 void
281 rconn_disconnect(struct rconn *rc)
282 {
283     if (rc->state != S_VOID) {
284         if (rc->vconn) {
285             vconn_close(rc->vconn);
286             rc->vconn = NULL;
287         }
288         rconn_set_target__(rc, "void", NULL);
289         rc->reliable = false;
290
291         rc->backoff = 0;
292         rc->backoff_deadline = TIME_MIN;
293
294         state_transition(rc, S_VOID);
295     }
296 }
297
298 /* Disconnects 'rc' and frees the underlying storage. */
299 void
300 rconn_destroy(struct rconn *rc)
301 {
302     if (rc) {
303         size_t i;
304
305         free(rc->name);
306         free(rc->target);
307         vconn_close(rc->vconn);
308         flush_queue(rc);
309         ofpbuf_list_delete(&rc->txq);
310         for (i = 0; i < rc->n_monitors; i++) {
311             vconn_close(rc->monitors[i]);
312         }
313         free(rc);
314     }
315 }
316
317 static unsigned int
318 timeout_VOID(const struct rconn *rc OVS_UNUSED)
319 {
320     return UINT_MAX;
321 }
322
323 static void
324 run_VOID(struct rconn *rc OVS_UNUSED)
325 {
326     /* Nothing to do. */
327 }
328
329 static void
330 reconnect(struct rconn *rc)
331 {
332     int retval;
333
334     if (rconn_logging_connection_attempts__(rc)) {
335         VLOG_INFO("%s: connecting...", rc->name);
336     }
337     rc->n_attempted_connections++;
338     retval = vconn_open(rc->target, OFP_VERSION, &rc->vconn);
339     if (!retval) {
340         rc->remote_ip = vconn_get_remote_ip(rc->vconn);
341         rc->local_ip = vconn_get_local_ip(rc->vconn);
342         rc->remote_port = vconn_get_remote_port(rc->vconn);
343         rc->backoff_deadline = time_now() + rc->backoff;
344         state_transition(rc, S_CONNECTING);
345     } else {
346         VLOG_WARN("%s: connection failed (%s)", rc->name, strerror(retval));
347         rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
348         disconnect(rc, retval);
349     }
350 }
351
352 static unsigned int
353 timeout_BACKOFF(const struct rconn *rc)
354 {
355     return rc->backoff;
356 }
357
358 static void
359 run_BACKOFF(struct rconn *rc)
360 {
361     if (timed_out(rc)) {
362         reconnect(rc);
363     }
364 }
365
366 static unsigned int
367 timeout_CONNECTING(const struct rconn *rc)
368 {
369     return MAX(1, rc->backoff);
370 }
371
372 static void
373 run_CONNECTING(struct rconn *rc)
374 {
375     int retval = vconn_connect(rc->vconn);
376     if (!retval) {
377         VLOG_INFO("%s: connected", rc->name);
378         rc->n_successful_connections++;
379         state_transition(rc, S_ACTIVE);
380         rc->last_connected = rc->state_entered;
381     } else if (retval != EAGAIN) {
382         if (rconn_logging_connection_attempts__(rc)) {
383             VLOG_INFO("%s: connection failed (%s)",
384                       rc->name, strerror(retval));
385         }
386         disconnect(rc, retval);
387     } else if (timed_out(rc)) {
388         if (rconn_logging_connection_attempts__(rc)) {
389             VLOG_INFO("%s: connection timed out", rc->name);
390         }
391         rc->backoff_deadline = TIME_MAX; /* Prevent resetting backoff. */
392         disconnect(rc, ETIMEDOUT);
393     }
394 }
395
396 static void
397 do_tx_work(struct rconn *rc)
398 {
399     if (list_is_empty(&rc->txq)) {
400         return;
401     }
402     while (!list_is_empty(&rc->txq)) {
403         int error = try_send(rc);
404         if (error) {
405             break;
406         }
407     }
408     if (list_is_empty(&rc->txq)) {
409         poll_immediate_wake();
410     }
411 }
412
413 static unsigned int
414 timeout_ACTIVE(const struct rconn *rc)
415 {
416     if (rc->probe_interval) {
417         unsigned int base = MAX(rc->last_received, rc->state_entered);
418         unsigned int arg = base + rc->probe_interval - rc->state_entered;
419         return arg;
420     }
421     return UINT_MAX;
422 }
423
424 static void
425 run_ACTIVE(struct rconn *rc)
426 {
427     if (timed_out(rc)) {
428         unsigned int base = MAX(rc->last_received, rc->state_entered);
429         VLOG_DBG("%s: idle %u seconds, sending inactivity probe",
430                  rc->name, (unsigned int) (time_now() - base));
431
432         /* Ordering is important here: rconn_send() can transition to BACKOFF,
433          * and we don't want to transition back to IDLE if so, because then we
434          * can end up queuing a packet with vconn == NULL and then *boom*. */
435         state_transition(rc, S_IDLE);
436         rconn_send(rc, make_echo_request(), NULL);
437         return;
438     }
439
440     do_tx_work(rc);
441 }
442
443 static unsigned int
444 timeout_IDLE(const struct rconn *rc)
445 {
446     return rc->probe_interval;
447 }
448
449 static void
450 run_IDLE(struct rconn *rc)
451 {
452     if (timed_out(rc)) {
453         VLOG_ERR("%s: no response to inactivity probe after %u "
454                  "seconds, disconnecting",
455                  rc->name, elapsed_in_this_state(rc));
456         disconnect(rc, ETIMEDOUT);
457     } else {
458         do_tx_work(rc);
459     }
460 }
461
462 /* Performs whatever activities are necessary to maintain 'rc': if 'rc' is
463  * disconnected, attempts to (re)connect, backing off as necessary; if 'rc' is
464  * connected, attempts to send packets in the send queue, if any. */
465 void
466 rconn_run(struct rconn *rc)
467 {
468     int old_state;
469     size_t i;
470
471     if (rc->vconn) {
472         vconn_run(rc->vconn);
473     }
474     for (i = 0; i < rc->n_monitors; i++) {
475         vconn_run(rc->monitors[i]);
476     }
477
478     do {
479         old_state = rc->state;
480         switch (rc->state) {
481 #define STATE(NAME, VALUE) case S_##NAME: run_##NAME(rc); break;
482             STATES
483 #undef STATE
484         default:
485             NOT_REACHED();
486         }
487     } while (rc->state != old_state);
488 }
489
490 /* Causes the next call to poll_block() to wake up when rconn_run() should be
491  * called on 'rc'. */
492 void
493 rconn_run_wait(struct rconn *rc)
494 {
495     unsigned int timeo;
496     size_t i;
497
498     if (rc->vconn) {
499         vconn_run_wait(rc->vconn);
500         if ((rc->state & (S_ACTIVE | S_IDLE)) && !list_is_empty(&rc->txq)) {
501             vconn_wait(rc->vconn, WAIT_SEND);
502         }
503     }
504     for (i = 0; i < rc->n_monitors; i++) {
505         vconn_run_wait(rc->monitors[i]);
506     }
507
508     timeo = timeout(rc);
509     if (timeo != UINT_MAX) {
510         long long int expires = sat_add(rc->state_entered, timeo);
511         poll_timer_wait_until(expires * 1000);
512     }
513 }
514
515 /* Attempts to receive a packet from 'rc'.  If successful, returns the packet;
516  * otherwise, returns a null pointer.  The caller is responsible for freeing
517  * the packet (with ofpbuf_delete()). */
518 struct ofpbuf *
519 rconn_recv(struct rconn *rc)
520 {
521     if (rc->state & (S_ACTIVE | S_IDLE)) {
522         struct ofpbuf *buffer;
523         int error = vconn_recv(rc->vconn, &buffer);
524         if (!error) {
525             copy_to_monitor(rc, buffer);
526             if (rc->probably_admitted || is_admitted_msg(buffer)
527                 || time_now() - rc->last_connected >= 30) {
528                 rc->probably_admitted = true;
529                 rc->last_admitted = time_now();
530             }
531             rc->last_received = time_now();
532             rc->packets_received++;
533             if (rc->state == S_IDLE) {
534                 state_transition(rc, S_ACTIVE);
535             }
536             return buffer;
537         } else if (error != EAGAIN) {
538             report_error(rc, error);
539             disconnect(rc, error);
540         }
541     }
542     return NULL;
543 }
544
545 /* Causes the next call to poll_block() to wake up when a packet may be ready
546  * to be received by vconn_recv() on 'rc'.  */
547 void
548 rconn_recv_wait(struct rconn *rc)
549 {
550     if (rc->vconn) {
551         vconn_wait(rc->vconn, WAIT_RECV);
552     }
553 }
554
555 /* Sends 'b' on 'rc'.  Returns 0 if successful (in which case 'b' is
556  * destroyed), or ENOTCONN if 'rc' is not currently connected (in which case
557  * the caller retains ownership of 'b').
558  *
559  * If 'counter' is non-null, then 'counter' will be incremented while the
560  * packet is in flight, then decremented when it has been sent (or discarded
561  * due to disconnection).  Because 'b' may be sent (or discarded) before this
562  * function returns, the caller may not be able to observe any change in
563  * 'counter'.
564  *
565  * There is no rconn_send_wait() function: an rconn has a send queue that it
566  * takes care of sending if you call rconn_run(), which will have the side
567  * effect of waking up poll_block(). */
568 int
569 rconn_send(struct rconn *rc, struct ofpbuf *b,
570            struct rconn_packet_counter *counter)
571 {
572     if (rconn_is_connected(rc)) {
573         COVERAGE_INC(rconn_queued);
574         copy_to_monitor(rc, b);
575         b->private_p = counter;
576         if (counter) {
577             rconn_packet_counter_inc(counter);
578         }
579         list_push_back(&rc->txq, &b->list_node);
580
581         /* If the queue was empty before we added 'b', try to send some
582          * packets.  (But if the queue had packets in it, it's because the
583          * vconn is backlogged and there's no point in stuffing more into it
584          * now.  We'll get back to that in rconn_run().) */
585         if (rc->txq.next == &b->list_node) {
586             try_send(rc);
587         }
588         return 0;
589     } else {
590         return ENOTCONN;
591     }
592 }
593
594 /* Sends 'b' on 'rc'.  Increments 'counter' while the packet is in flight; it
595  * will be decremented when it has been sent (or discarded due to
596  * disconnection).  Returns 0 if successful, EAGAIN if 'counter->n' is already
597  * at least as large as 'queue_limit', or ENOTCONN if 'rc' is not currently
598  * connected.  Regardless of return value, 'b' is destroyed.
599  *
600  * Because 'b' may be sent (or discarded) before this function returns, the
601  * caller may not be able to observe any change in 'counter'.
602  *
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(). */
606 int
607 rconn_send_with_limit(struct rconn *rc, struct ofpbuf *b,
608                       struct rconn_packet_counter *counter, int queue_limit)
609 {
610     int retval;
611     retval = counter->n >= queue_limit ? EAGAIN : rconn_send(rc, b, counter);
612     if (retval) {
613         COVERAGE_INC(rconn_overflow);
614         ofpbuf_delete(b);
615     }
616     return retval;
617 }
618
619 /* Returns the total number of packets successfully sent on the underlying
620  * vconn.  A packet is not counted as sent while it is still queued in the
621  * rconn, only when it has been successfuly passed to the vconn.  */
622 unsigned int
623 rconn_packets_sent(const struct rconn *rc)
624 {
625     return rc->packets_sent;
626 }
627
628 /* Adds 'vconn' to 'rc' as a monitoring connection, to which all messages sent
629  * and received on 'rconn' will be copied.  'rc' takes ownership of 'vconn'. */
630 void
631 rconn_add_monitor(struct rconn *rc, struct vconn *vconn)
632 {
633     if (rc->n_monitors < ARRAY_SIZE(rc->monitors)) {
634         VLOG_INFO("new monitor connection from %s", vconn_get_name(vconn));
635         rc->monitors[rc->n_monitors++] = vconn;
636     } else {
637         VLOG_DBG("too many monitor connections, discarding %s",
638                  vconn_get_name(vconn));
639         vconn_close(vconn);
640     }
641 }
642
643 /* Returns 'rc''s name.  This is a name for human consumption, appropriate for
644  * use in log messages.  It is not necessarily a name that may be passed
645  * directly to, e.g., vconn_open(). */
646 const char *
647 rconn_get_name(const struct rconn *rc)
648 {
649     return rc->name;
650 }
651
652 /* Sets 'rc''s name to 'new_name'. */
653 void
654 rconn_set_name(struct rconn *rc, const char *new_name)
655 {
656     free(rc->name);
657     rc->name = xstrdup(new_name);
658 }
659
660 /* Returns 'rc''s target.  This is intended to be a string that may be passed
661  * directly to, e.g., vconn_open(). */
662 const char *
663 rconn_get_target(const struct rconn *rc)
664 {
665     return rc->target;
666 }
667
668 /* Returns true if 'rconn' is connected or in the process of reconnecting,
669  * false if 'rconn' is disconnected and will not reconnect on its own. */
670 bool
671 rconn_is_alive(const struct rconn *rconn)
672 {
673     return rconn->state != S_VOID;
674 }
675
676 /* Returns true if 'rconn' is connected, false otherwise. */
677 bool
678 rconn_is_connected(const struct rconn *rconn)
679 {
680     return is_connected_state(rconn->state);
681 }
682
683 /* Returns true if 'rconn' is connected and thought to have been accepted by
684  * the peer's admission-control policy. */
685 bool
686 rconn_is_admitted(const struct rconn *rconn)
687 {
688     return (rconn_is_connected(rconn)
689             && rconn->last_admitted >= rconn->last_connected);
690 }
691
692 /* Returns 0 if 'rconn' is currently connected and considered to have been
693  * accepted by the peer's admission-control policy, otherwise the number of
694  * seconds since 'rconn' was last in such a state. */
695 int
696 rconn_failure_duration(const struct rconn *rconn)
697 {
698     return rconn_is_admitted(rconn) ? 0 : time_now() - rconn->last_admitted;
699 }
700
701 /* Returns the IP address of the peer, or 0 if the peer's IP address is not
702  * known. */
703 uint32_t
704 rconn_get_remote_ip(const struct rconn *rconn)
705 {
706     return rconn->remote_ip;
707 }
708
709 /* Returns the transport port of the peer, or 0 if the peer's port is not
710  * known. */
711 uint16_t
712 rconn_get_remote_port(const struct rconn *rconn)
713 {
714     return rconn->remote_port;
715 }
716
717 /* Returns the IP address used to connect to the peer, or 0 if the
718  * connection is not an IP-based protocol or if its IP address is not
719  * known. */
720 uint32_t
721 rconn_get_local_ip(const struct rconn *rconn)
722 {
723     return rconn->local_ip;
724 }
725
726 /* Returns the transport port used to connect to the peer, or 0 if the
727  * connection does not contain a port or if the port is not known. */
728 uint16_t
729 rconn_get_local_port(const struct rconn *rconn)
730 {
731     return rconn->vconn ? vconn_get_local_port(rconn->vconn) : 0;
732 }
733
734 /* Returns the total number of packets successfully received by the underlying
735  * vconn.  */
736 unsigned int
737 rconn_packets_received(const struct rconn *rc)
738 {
739     return rc->packets_received;
740 }
741
742 /* Returns a string representing the internal state of 'rc'.  The caller must
743  * not modify or free the string. */
744 const char *
745 rconn_get_state(const struct rconn *rc)
746 {
747     return state_name(rc->state);
748 }
749
750 /* Returns the number of connection attempts made by 'rc', including any
751  * ongoing attempt that has not yet succeeded or failed. */
752 unsigned int
753 rconn_get_attempted_connections(const struct rconn *rc)
754 {
755     return rc->n_attempted_connections;
756 }
757
758 /* Returns the number of successful connection attempts made by 'rc'. */
759 unsigned int
760 rconn_get_successful_connections(const struct rconn *rc)
761 {
762     return rc->n_successful_connections;
763 }
764
765 /* Returns the time at which the last successful connection was made by
766  * 'rc'. Returns TIME_MIN if never connected. */
767 time_t
768 rconn_get_last_connection(const struct rconn *rc)
769 {
770     return rc->last_connected;
771 }
772
773 /* Returns the time at which 'rc' was last disconnected. Returns TIME_MIN
774  * if never disconnected. */
775 time_t
776 rconn_get_last_disconnect(const struct rconn *rc)
777 {
778     return rc->last_disconnected;
779 }
780
781 /* Returns the time at which the last OpenFlow message was received by 'rc'.
782  * If no packets have been received on 'rc', returns the time at which 'rc'
783  * was created. */
784 time_t
785 rconn_get_last_received(const struct rconn *rc)
786 {
787     return rc->last_received;
788 }
789
790 /* Returns the time at which 'rc' was created. */
791 time_t
792 rconn_get_creation_time(const struct rconn *rc)
793 {
794     return rc->creation_time;
795 }
796
797 /* Returns the approximate number of seconds that 'rc' has been connected. */
798 unsigned long int
799 rconn_get_total_time_connected(const struct rconn *rc)
800 {
801     return (rc->total_time_connected
802             + (rconn_is_connected(rc) ? elapsed_in_this_state(rc) : 0));
803 }
804
805 /* Returns the current amount of backoff, in seconds.  This is the amount of
806  * time after which the rconn will transition from BACKOFF to CONNECTING. */
807 int
808 rconn_get_backoff(const struct rconn *rc)
809 {
810     return rc->backoff;
811 }
812
813 /* Returns the number of seconds spent in this state so far. */
814 unsigned int
815 rconn_get_state_elapsed(const struct rconn *rc)
816 {
817     return elapsed_in_this_state(rc);
818 }
819
820 /* Returns 'rc''s current connection sequence number, a number that changes
821  * every time that 'rconn' connects or disconnects. */
822 unsigned int
823 rconn_get_connection_seqno(const struct rconn *rc)
824 {
825     return rc->seqno;
826 }
827
828 /* Returns a value that explains why 'rc' last disconnected:
829  *
830  *   - 0 means that the last disconnection was caused by a call to
831  *     rconn_disconnect(), or that 'rc' is new and has not yet completed its
832  *     initial connection or connection attempt.
833  *
834  *   - EOF means that the connection was closed in the normal way by the peer.
835  *
836  *   - A positive integer is an errno value that represents the error.
837  */
838 int
839 rconn_get_last_error(const struct rconn *rc)
840 {
841     return rc->last_error;
842 }
843 \f
844 struct rconn_packet_counter *
845 rconn_packet_counter_create(void)
846 {
847     struct rconn_packet_counter *c = xmalloc(sizeof *c);
848     c->n = 0;
849     c->ref_cnt = 1;
850     return c;
851 }
852
853 void
854 rconn_packet_counter_destroy(struct rconn_packet_counter *c)
855 {
856     if (c) {
857         assert(c->ref_cnt > 0);
858         if (!--c->ref_cnt && !c->n) {
859             free(c);
860         }
861     }
862 }
863
864 void
865 rconn_packet_counter_inc(struct rconn_packet_counter *c)
866 {
867     c->n++;
868 }
869
870 void
871 rconn_packet_counter_dec(struct rconn_packet_counter *c)
872 {
873     assert(c->n > 0);
874     if (!--c->n && !c->ref_cnt) {
875         free(c);
876     }
877 }
878 \f
879 /* Set rc->target and rc->name to 'target' and 'name', respectively.  If 'name'
880  * is null, 'target' is used.
881  *
882  * Also, clear out the cached IP address and port information, since changing
883  * the target also likely changes these values. */
884 static void
885 rconn_set_target__(struct rconn *rc, const char *target, const char *name)
886 {
887     free(rc->name);
888     rc->name = xstrdup(name ? name : target);
889     free(rc->target);
890     rc->target = xstrdup(target);
891     rc->local_ip = 0;
892     rc->remote_ip = 0;
893     rc->remote_port = 0;
894 }
895
896 /* Tries to send a packet from 'rc''s send buffer.  Returns 0 if successful,
897  * otherwise a positive errno value. */
898 static int
899 try_send(struct rconn *rc)
900 {
901     struct ofpbuf *msg = ofpbuf_from_list(rc->txq.next);
902     struct rconn_packet_counter *counter = msg->private_p;
903     int retval;
904
905     /* Eagerly remove 'msg' from the txq.  We can't remove it from the list
906      * after sending, if sending is successful, because it is then owned by the
907      * vconn, which might have freed it already. */
908     list_remove(&msg->list_node);
909
910     retval = vconn_send(rc->vconn, msg);
911     if (retval) {
912         list_push_front(&rc->txq, &msg->list_node);
913         if (retval != EAGAIN) {
914             report_error(rc, retval);
915             disconnect(rc, retval);
916         }
917         return retval;
918     }
919     COVERAGE_INC(rconn_sent);
920     rc->packets_sent++;
921     if (counter) {
922         rconn_packet_counter_dec(counter);
923     }
924     return 0;
925 }
926
927 /* Reports that 'error' caused 'rc' to disconnect.  'error' may be a positive
928  * errno value, or it may be EOF to indicate that the connection was closed
929  * normally. */
930 static void
931 report_error(struct rconn *rc, int error)
932 {
933     if (error == EOF) {
934         /* If 'rc' isn't reliable, then we don't really expect this connection
935          * to last forever anyway (probably it's a connection that we received
936          * via accept()), so use DBG level to avoid cluttering the logs. */
937         enum vlog_level level = rc->reliable ? VLL_INFO : VLL_DBG;
938         VLOG(level, "%s: connection closed by peer", rc->name);
939     } else {
940         VLOG_WARN("%s: connection dropped (%s)", rc->name, strerror(error));
941     }
942 }
943
944 /* Disconnects 'rc' and records 'error' as the error that caused 'rc''s last
945  * disconnection:
946  *
947  *   - 0 means that this disconnection is due to a request by 'rc''s client,
948  *     not due to any kind of network error.
949  *
950  *   - EOF means that the connection was closed in the normal way by the peer.
951  *
952  *   - A positive integer is an errno value that represents the error.
953  */
954 static void
955 disconnect(struct rconn *rc, int error)
956 {
957     rc->last_error = error;
958     if (rc->reliable) {
959         time_t now = time_now();
960
961         if (rc->state & (S_CONNECTING | S_ACTIVE | S_IDLE)) {
962             rc->last_disconnected = now;
963             vconn_close(rc->vconn);
964             rc->vconn = NULL;
965             flush_queue(rc);
966         }
967
968         if (now >= rc->backoff_deadline) {
969             rc->backoff = 1;
970         } else if (rc->backoff < rc->max_backoff / 2) {
971             rc->backoff = MAX(1, 2 * rc->backoff);
972             VLOG_INFO("%s: waiting %d seconds before reconnect",
973                       rc->name, rc->backoff);
974         } else {
975             if (rconn_logging_connection_attempts__(rc)) {
976                 VLOG_INFO("%s: continuing to retry connections in the "
977                           "background but suppressing further logging",
978                           rc->name);
979             }
980             rc->backoff = rc->max_backoff;
981         }
982         rc->backoff_deadline = now + rc->backoff;
983         state_transition(rc, S_BACKOFF);
984     } else {
985         rc->last_disconnected = time_now();
986         rconn_disconnect(rc);
987     }
988 }
989
990 /* Drops all the packets from 'rc''s send queue and decrements their queue
991  * counts. */
992 static void
993 flush_queue(struct rconn *rc)
994 {
995     if (list_is_empty(&rc->txq)) {
996         return;
997     }
998     while (!list_is_empty(&rc->txq)) {
999         struct ofpbuf *b = ofpbuf_from_list(list_pop_front(&rc->txq));
1000         struct rconn_packet_counter *counter = b->private_p;
1001         if (counter) {
1002             rconn_packet_counter_dec(counter);
1003         }
1004         COVERAGE_INC(rconn_discarded);
1005         ofpbuf_delete(b);
1006     }
1007     poll_immediate_wake();
1008 }
1009
1010 static unsigned int
1011 elapsed_in_this_state(const struct rconn *rc)
1012 {
1013     return time_now() - rc->state_entered;
1014 }
1015
1016 static unsigned int
1017 timeout(const struct rconn *rc)
1018 {
1019     switch (rc->state) {
1020 #define STATE(NAME, VALUE) case S_##NAME: return timeout_##NAME(rc);
1021         STATES
1022 #undef STATE
1023     default:
1024         NOT_REACHED();
1025     }
1026 }
1027
1028 static bool
1029 timed_out(const struct rconn *rc)
1030 {
1031     return time_now() >= sat_add(rc->state_entered, timeout(rc));
1032 }
1033
1034 static void
1035 state_transition(struct rconn *rc, enum state state)
1036 {
1037     rc->seqno += (rc->state == S_ACTIVE) != (state == S_ACTIVE);
1038     if (is_connected_state(state) && !is_connected_state(rc->state)) {
1039         rc->probably_admitted = false;
1040     }
1041     if (rconn_is_connected(rc)) {
1042         rc->total_time_connected += elapsed_in_this_state(rc);
1043     }
1044     VLOG_DBG("%s: entering %s", rc->name, state_name(state));
1045     rc->state = state;
1046     rc->state_entered = time_now();
1047 }
1048
1049 static void
1050 copy_to_monitor(struct rconn *rc, const struct ofpbuf *b)
1051 {
1052     struct ofpbuf *clone = NULL;
1053     int retval;
1054     size_t i;
1055
1056     for (i = 0; i < rc->n_monitors; ) {
1057         struct vconn *vconn = rc->monitors[i];
1058
1059         if (!clone) {
1060             clone = ofpbuf_clone(b);
1061         }
1062         retval = vconn_send(vconn, clone);
1063         if (!retval) {
1064             clone = NULL;
1065         } else if (retval != EAGAIN) {
1066             VLOG_DBG("%s: closing monitor connection to %s: %s",
1067                      rconn_get_name(rc), vconn_get_name(vconn),
1068                      strerror(retval));
1069             rc->monitors[i] = rc->monitors[--rc->n_monitors];
1070             continue;
1071         }
1072         i++;
1073     }
1074     ofpbuf_delete(clone);
1075 }
1076
1077 static bool
1078 is_connected_state(enum state state)
1079 {
1080     return (state & (S_ACTIVE | S_IDLE)) != 0;
1081 }
1082
1083 static bool
1084 is_admitted_msg(const struct ofpbuf *b)
1085 {
1086     struct ofp_header *oh = b->data;
1087     uint8_t type = oh->type;
1088     return !(type < 32
1089              && (1u << type) & ((1u << OFPT_HELLO) |
1090                                 (1u << OFPT_ERROR) |
1091                                 (1u << OFPT_ECHO_REQUEST) |
1092                                 (1u << OFPT_ECHO_REPLY) |
1093                                 (1u << OFPT_VENDOR) |
1094                                 (1u << OFPT_FEATURES_REQUEST) |
1095                                 (1u << OFPT_FEATURES_REPLY) |
1096                                 (1u << OFPT_GET_CONFIG_REQUEST) |
1097                                 (1u << OFPT_GET_CONFIG_REPLY) |
1098                                 (1u << OFPT_SET_CONFIG)));
1099 }
1100
1101 /* Returns true if 'rc' is currently logging information about connection
1102  * attempts, false if logging should be suppressed because 'rc' hasn't
1103  * successuflly connected in too long. */
1104 static bool
1105 rconn_logging_connection_attempts__(const struct rconn *rc)
1106 {
1107     return rc->backoff < rc->max_backoff;
1108 }