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