3cc8d7073ae3467d04fed6468f1af943b7c15b0f
[controller.git] / opendaylight / md-sal / cds-access-client / src / main / java / org / opendaylight / controller / cluster / access / client / AbstractClientConnection.java
1 /*
2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.controller.cluster.access.client;
9
10 import akka.actor.ActorRef;
11 import com.google.common.annotations.VisibleForTesting;
12 import com.google.common.base.MoreObjects;
13 import com.google.common.base.MoreObjects.ToStringHelper;
14 import com.google.common.base.Preconditions;
15 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
16 import java.util.Collection;
17 import java.util.Optional;
18 import java.util.concurrent.TimeUnit;
19 import java.util.concurrent.TimeoutException;
20 import java.util.concurrent.locks.Lock;
21 import java.util.concurrent.locks.ReentrantLock;
22 import java.util.function.Consumer;
23 import javax.annotation.Nonnull;
24 import javax.annotation.concurrent.GuardedBy;
25 import javax.annotation.concurrent.NotThreadSafe;
26 import org.opendaylight.controller.cluster.access.concepts.Request;
27 import org.opendaylight.controller.cluster.access.concepts.RequestException;
28 import org.opendaylight.controller.cluster.access.concepts.Response;
29 import org.opendaylight.controller.cluster.access.concepts.ResponseEnvelope;
30 import org.opendaylight.controller.cluster.access.concepts.RuntimeRequestException;
31 import org.slf4j.Logger;
32 import org.slf4j.LoggerFactory;
33 import scala.concurrent.duration.FiniteDuration;
34
35 /**
36  * Base class for a connection to the backend. Responsible to queueing and dispatch of requests toward the backend.
37  * Can be in three conceptual states: Connecting, Connected and Reconnecting, which are represented by public final
38  * classes exposed from this package.
39  *
40  * @author Robert Varga
41  */
42 @NotThreadSafe
43 public abstract class AbstractClientConnection<T extends BackendInfo> {
44     private static final Logger LOG = LoggerFactory.getLogger(AbstractClientConnection.class);
45
46     /*
47      * Timers involved in communication with the backend. There are three tiers which are spaced out to allow for
48      * recovery at each tier. Keep these constants in nanoseconds, as that prevents unnecessary conversions in the fast
49      * path.
50      */
51     /**
52      * Backend aliveness timer. This is reset whenever we receive a response from the backend and kept armed whenever
53      * we have an outstanding request. If when this time expires, we tear down this connection and attempt to reconnect
54      * it.
55      */
56     public static final long DEFAULT_BACKEND_ALIVE_TIMEOUT_NANOS = TimeUnit.SECONDS.toNanos(30);
57
58     /**
59      * Request timeout. If the request fails to complete within this time since it was originally enqueued, we time
60      * the request out.
61      */
62     public static final long DEFAULT_REQUEST_TIMEOUT_NANOS = TimeUnit.MINUTES.toNanos(2);
63
64     /**
65      * No progress timeout. A client fails to make any forward progress in this time, it will terminate itself.
66      */
67     public static final long DEFAULT_NO_PROGRESS_TIMEOUT_NANOS = TimeUnit.MINUTES.toNanos(15);
68
69     // Emit a debug entry if we sleep for more that this amount
70     private static final long DEBUG_DELAY_NANOS = TimeUnit.MILLISECONDS.toNanos(100);
71
72     // Upper bound on the time a thread is forced to sleep to keep queue size under control
73     private static final long MAX_DELAY_SECONDS = 5;
74     private static final long MAX_DELAY_NANOS = TimeUnit.SECONDS.toNanos(MAX_DELAY_SECONDS);
75
76     private final Lock lock = new ReentrantLock();
77     private final ClientActorContext context;
78     @GuardedBy("lock")
79     private final TransmitQueue queue;
80     private final Long cookie;
81
82     @GuardedBy("lock")
83     private boolean haveTimer;
84
85     /**
86      * Time reference when we saw any activity from the backend.
87      */
88     private long lastReceivedTicks;
89
90     private volatile RequestException poisoned;
91
92     // Private constructor to avoid code duplication.
93     private AbstractClientConnection(final AbstractClientConnection<T> oldConn, final TransmitQueue newQueue) {
94         this.context = Preconditions.checkNotNull(oldConn.context);
95         this.cookie = Preconditions.checkNotNull(oldConn.cookie);
96         this.queue = Preconditions.checkNotNull(newQueue);
97         // Will be updated in finishReplay if needed.
98         this.lastReceivedTicks = oldConn.lastReceivedTicks;
99     }
100
101     // This constructor is only to be called by ConnectingClientConnection constructor.
102     // Do not allow subclassing outside of this package
103     AbstractClientConnection(final ClientActorContext context, final Long cookie, final int queueDepth) {
104         this.context = Preconditions.checkNotNull(context);
105         this.cookie = Preconditions.checkNotNull(cookie);
106         this.queue = new TransmitQueue.Halted(queueDepth);
107         this.lastReceivedTicks = currentTime();
108     }
109
110     // This constructor is only to be called (indirectly) by ReconnectingClientConnection constructor.
111     // Do not allow subclassing outside of this package
112     AbstractClientConnection(final AbstractClientConnection<T> oldConn) {
113         this(oldConn, new TransmitQueue.Halted(oldConn.queue, oldConn.currentTime()));
114     }
115
116     // This constructor is only to be called (indirectly) by ConnectedClientConnection constructor.
117     // Do not allow subclassing outside of this package
118     AbstractClientConnection(final AbstractClientConnection<T> oldConn, final T newBackend, final int queueDepth) {
119         this(oldConn, new TransmitQueue.Transmitting(oldConn.queue, queueDepth, newBackend, oldConn.currentTime()));
120     }
121
122     public final ClientActorContext context() {
123         return context;
124     }
125
126     public final @Nonnull Long cookie() {
127         return cookie;
128     }
129
130     public final ActorRef localActor() {
131         return context.self();
132     }
133
134     public final long currentTime() {
135         return context.ticker().read();
136     }
137
138     /**
139      * Send a request to the backend and invoke a specified callback when it finishes. This method is safe to invoke
140      * from any thread.
141      *
142      * <p>This method may put the caller thread to sleep in order to throttle the request rate.
143      * The callback may be called before the sleep finishes.
144      *
145      * @param request Request to send
146      * @param callback Callback to invoke
147      */
148     public final void sendRequest(final Request<?, ?> request, final Consumer<Response<?, ?>> callback) {
149         final long now = currentTime();
150         sendEntry(new ConnectionEntry(request, callback, now), now);
151     }
152
153     /**
154      * Send a request to the backend and invoke a specified callback when it finishes. This method is safe to invoke
155      * from any thread.
156      *
157      * <p>
158      * Note that unlike {@link #sendRequest(Request, Consumer)}, this method does not exert backpressure, hence it
159      * should never be called from an application thread.
160      *
161      * @param request Request to send
162      * @param callback Callback to invoke
163      * @param enqueuedTicks Time (according to {@link #currentTime()} of request enqueue
164      */
165     public final void enqueueRequest(final Request<?, ?> request, final Consumer<Response<?, ?>> callback,
166             final long enqueuedTicks) {
167         enqueueEntry(new ConnectionEntry(request, callback, enqueuedTicks), currentTime());
168     }
169
170     private long enqueueOrForward(final ConnectionEntry entry, final long now) {
171         lock.lock();
172         try {
173             commonEnqueue(entry, now);
174             return queue.enqueueOrForward(entry, now);
175         } finally {
176             lock.unlock();
177         }
178     }
179
180     /**
181      * Enqueue an entry, possibly also transmitting it.
182      */
183     public final void enqueueEntry(final ConnectionEntry entry, final long now) {
184         lock.lock();
185         try {
186             commonEnqueue(entry, now);
187             queue.enqueueOrReplay(entry, now);
188         } finally {
189             lock.unlock();
190         }
191     }
192
193     @GuardedBy("lock")
194     private void commonEnqueue(final ConnectionEntry entry, final long now) {
195         final RequestException maybePoison = poisoned;
196         if (maybePoison != null) {
197             throw new IllegalStateException("Connection " + this + " has been poisoned", maybePoison);
198         }
199
200         if (queue.isEmpty()) {
201             // The queue is becoming non-empty, schedule a timer.
202             scheduleTimer(entry.getEnqueuedTicks() + context.config().getRequestTimeout() - now);
203         }
204     }
205
206     // To be called from ClientActorBehavior on ConnectedClientConnection after entries are replayed.
207     final void cancelDebt() {
208         queue.cancelDebt(currentTime());
209     }
210
211     public abstract Optional<T> getBackendInfo();
212
213     final Collection<ConnectionEntry> startReplay() {
214         lock.lock();
215         return queue.drain();
216     }
217
218     @GuardedBy("lock")
219     final void finishReplay(final ReconnectForwarder forwarder) {
220         setForwarder(forwarder);
221
222         /*
223          * The process of replaying all messages may have taken a significant chunk of time, depending on type
224          * of messages, queue depth and available processing power. In extreme situations this may have already
225          * exceeded BACKEND_ALIVE_TIMEOUT_NANOS, in which case we are running the risk of not making reasonable forward
226          * progress before we start a reconnect cycle.
227          *
228          * Note that the timer is armed after we have sent the first message, hence we should be seeing a response
229          * from the backend before we see a timeout, simply due to how the mailbox operates.
230          *
231          * At any rate, reset the timestamp once we complete reconnection (which an atomic transition from the
232          * perspective of outside world), as that makes it a bit easier to reason about timing of events.
233          */
234         lastReceivedTicks = currentTime();
235         lock.unlock();
236     }
237
238     @GuardedBy("lock")
239     final void setForwarder(final ReconnectForwarder forwarder) {
240         queue.setForwarder(forwarder, currentTime());
241     }
242
243     @GuardedBy("lock")
244     abstract ClientActorBehavior<T> lockedReconnect(ClientActorBehavior<T> current,
245             RequestException runtimeRequestException);
246
247     final void sendEntry(final ConnectionEntry entry, final long now) {
248         long delay = enqueueOrForward(entry, now);
249         try {
250             if (delay >= DEBUG_DELAY_NANOS) {
251                 if (delay > MAX_DELAY_NANOS) {
252                     LOG.info("Capping {} throttle delay from {} to {} seconds", this,
253                         TimeUnit.NANOSECONDS.toSeconds(delay), MAX_DELAY_SECONDS, new Throwable());
254                     delay = MAX_DELAY_NANOS;
255                 }
256                 if (LOG.isDebugEnabled()) {
257                     LOG.debug("{}: Sleeping for {}ms on connection {}", context.persistenceId(),
258                         TimeUnit.NANOSECONDS.toMillis(delay), this);
259                 }
260             }
261             TimeUnit.NANOSECONDS.sleep(delay);
262         } catch (InterruptedException e) {
263             Thread.currentThread().interrupt();
264             LOG.debug("Interrupted after sleeping {}ns", e, currentTime() - now);
265         }
266     }
267
268     final ClientActorBehavior<T> reconnect(final ClientActorBehavior<T> current, final RequestException cause) {
269         lock.lock();
270         try {
271             return lockedReconnect(current, cause);
272         } finally {
273             lock.unlock();
274         }
275     }
276
277     /**
278      * Schedule a timer to fire on the actor thread after a delay.
279      *
280      * @param delay Delay, in nanoseconds
281      */
282     @GuardedBy("lock")
283     private void scheduleTimer(final long delay) {
284         if (haveTimer) {
285             LOG.debug("{}: timer already scheduled on {}", context.persistenceId(), this);
286             return;
287         }
288         if (queue.hasSuccessor()) {
289             LOG.debug("{}: connection {} has a successor, not scheduling timer", context.persistenceId(), this);
290             return;
291         }
292
293         // If the delay is negative, we need to schedule an action immediately. While the caller could have checked
294         // for that condition and take appropriate action, but this is more convenient and less error-prone.
295         final long normalized =  delay <= 0 ? 0 : Math.min(delay, context.config().getBackendAlivenessTimerInterval());
296
297         final FiniteDuration dur = FiniteDuration.fromNanos(normalized);
298         LOG.debug("{}: connection {} scheduling timeout in {}", context.persistenceId(), this, dur);
299         context.executeInActor(this::runTimer, dur);
300         haveTimer = true;
301     }
302
303     /**
304      * Check this queue for timeout and initiate reconnection if that happened. If the queue has not made progress
305      * in {@link #DEFAULT_NO_PROGRESS_TIMEOUT_NANOS} nanoseconds, it will be aborted.
306      *
307      * @param current Current behavior
308      * @return Next behavior to use
309      */
310     @VisibleForTesting
311     final ClientActorBehavior<T> runTimer(final ClientActorBehavior<T> current) {
312         final Optional<Long> delay;
313
314         lock.lock();
315         try {
316             haveTimer = false;
317             final long now = currentTime();
318
319             LOG.debug("{}: running timer on {}", context.persistenceId(), this);
320
321             // The following line is only reliable when queue is not forwarding, but such state should not last long.
322             // FIXME: BUG-8422: this may not be accurate w.r.t. replayed entries
323             final long ticksSinceProgress = queue.ticksStalling(now);
324             if (ticksSinceProgress >= context.config().getNoProgressTimeout()) {
325                 LOG.error("Queue {} has not seen progress in {} seconds, failing all requests", this,
326                     TimeUnit.NANOSECONDS.toSeconds(ticksSinceProgress));
327
328                 lockedPoison(new NoProgressException(ticksSinceProgress));
329                 current.removeConnection(this);
330                 return current;
331             }
332
333             // Requests are always scheduled in sequence, hence checking for timeout is relatively straightforward.
334             // Note we use also inquire about the delay, so we can re-schedule if needed, hence the unusual tri-state
335             // return convention.
336             delay = lockedCheckTimeout(now);
337             if (delay == null) {
338                 // We have timed out. There is no point in scheduling a timer
339                 LOG.debug("{}: connection {} timed out", context.persistenceId(), this);
340                 return lockedReconnect(current, new RuntimeRequestException("Backend connection timed out",
341                     new TimeoutException()));
342             }
343
344             if (delay.isPresent()) {
345                 // If there is new delay, schedule a timer
346                 scheduleTimer(delay.get());
347             } else {
348                 LOG.debug("{}: not scheduling timeout on {}", context.persistenceId(), this);
349             }
350         } finally {
351             lock.unlock();
352         }
353
354         return current;
355     }
356
357     @VisibleForTesting
358     final Optional<Long> checkTimeout(final long now) {
359         lock.lock();
360         try {
361             return lockedCheckTimeout(now);
362         } finally {
363             lock.unlock();
364         }
365     }
366
367     long backendSilentTicks(final long now) {
368         return now - lastReceivedTicks;
369     }
370
371     /*
372      * We are using tri-state return here to indicate one of three conditions:
373      * - if there is no timeout to schedule, return Optional.empty()
374      * - if there is a timeout to schedule, return a non-empty optional
375      * - if this connections has timed out, return null
376      */
377     @SuppressFBWarnings(value = "NP_OPTIONAL_RETURN_NULL",
378             justification = "Returning null Optional is documented in the API contract.")
379     @GuardedBy("lock")
380     private Optional<Long> lockedCheckTimeout(final long now) {
381         if (queue.isEmpty()) {
382             LOG.debug("{}: connection {} is empty", context.persistenceId(), this);
383             return Optional.empty();
384         }
385
386         final long backendSilentTicks = backendSilentTicks(now);
387         if (backendSilentTicks >= context.config().getBackendAlivenessTimerInterval()) {
388             LOG.debug("{}: Connection {} has not seen activity from backend for {} nanoseconds, timing out",
389                 context.persistenceId(), this, backendSilentTicks);
390             return null;
391         }
392
393         int tasksTimedOut = 0;
394         for (ConnectionEntry head = queue.peek(); head != null; head = queue.peek()) {
395             final long beenOpen = now - head.getEnqueuedTicks();
396             final long requestTimeout = context.config().getRequestTimeout();
397             if (beenOpen < requestTimeout) {
398                 return Optional.of(requestTimeout - beenOpen);
399             }
400
401             tasksTimedOut++;
402             queue.remove(now);
403             LOG.debug("{}: Connection {} timed out entry {}", context.persistenceId(), this, head);
404
405             final double time = beenOpen * 1.0 / 1_000_000_000;
406             head.complete(head.getRequest().toRequestFailure(
407                 new RequestTimeoutException("Timed out after " + time + "seconds")));
408         }
409
410         LOG.debug("Connection {} timed out {} tasks", this, tasksTimedOut);
411         if (tasksTimedOut != 0) {
412             queue.tryTransmit(now);
413         }
414
415         return Optional.empty();
416     }
417
418     final void poison(final RequestException cause) {
419         lock.lock();
420         try {
421             lockedPoison(cause);
422         } finally {
423             lock.unlock();
424         }
425     }
426
427     @GuardedBy("lock")
428     private void lockedPoison(final RequestException cause) {
429         poisoned = enrichPoison(cause);
430         queue.poison(cause);
431     }
432
433     RequestException enrichPoison(final RequestException ex) {
434         return ex;
435     }
436
437     @VisibleForTesting
438     final RequestException poisoned() {
439         return poisoned;
440     }
441
442     void receiveResponse(final ResponseEnvelope<?> envelope) {
443         final long now = currentTime();
444         lastReceivedTicks = now;
445
446         final Optional<TransmittedConnectionEntry> maybeEntry;
447         lock.lock();
448         try {
449             maybeEntry = queue.complete(envelope, now);
450         } finally {
451             lock.unlock();
452         }
453
454         if (maybeEntry.isPresent()) {
455             final TransmittedConnectionEntry entry = maybeEntry.get();
456             LOG.debug("Completing {} with {}", entry, envelope);
457             entry.complete(envelope.getMessage());
458         }
459     }
460
461     @Override
462     public final String toString() {
463         return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
464     }
465
466     ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
467         return toStringHelper.add("client", context.getIdentifier()).add("cookie", cookie).add("poisoned", poisoned);
468     }
469 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.