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 attept to reconnect
  54      * it.
  55      */
  56     @VisibleForTesting
  57     static final long BACKEND_ALIVE_TIMEOUT_NANOS = TimeUnit.SECONDS.toNanos(30);
  58
  59     /**
  60      * Request timeout. If the request fails to complete within this time since it was originally enqueued, we time
  61      * the request out.
  62      */
  63     @VisibleForTesting
  64     static final long REQUEST_TIMEOUT_NANOS = TimeUnit.MINUTES.toNanos(2);
  65
  66     /**
  67      * No progress timeout. A client fails to make any forward progress in this time, it will terminate itself.
  68      */
  69     @VisibleForTesting
  70     static final long NO_PROGRESS_TIMEOUT_NANOS = TimeUnit.MINUTES.toNanos(15);
  71
  72     private final Lock lock = new ReentrantLock();
  73     private final ClientActorContext context;
  74     @GuardedBy("lock")
  75     private final TransmitQueue queue;
  76     private final Long cookie;
  77
  78     @GuardedBy("lock")
  79     private boolean haveTimer;
  80
  81     /**
  82      * Time reference when we saw any activity from the backend.
  83      */
  84     private long lastReceivedTicks;
  85
  86     private volatile RequestException poisoned;
  87
  88     // Do not allow subclassing outside of this package
  89     AbstractClientConnection(final ClientActorContext context, final Long cookie,
  90             final TransmitQueue queue) {
  91         this.context = Preconditions.checkNotNull(context);
  92         this.cookie = Preconditions.checkNotNull(cookie);
  93         this.queue = Preconditions.checkNotNull(queue);
  94         this.lastReceivedTicks = currentTime();
  95     }
  96
  97     // Do not allow subclassing outside of this package
  98     AbstractClientConnection(final AbstractClientConnection<T> oldConnection, final int targetQueueSize) {
  99         this.context = oldConnection.context;
 100         this.cookie = oldConnection.cookie;
 101         this.queue = new TransmitQueue.Halted(targetQueueSize);
 102         this.lastReceivedTicks = oldConnection.lastReceivedTicks;
 103     }
 104
 105     public final ClientActorContext context() {
 106         return context;
 107     }
 108
 109     public final @Nonnull Long cookie() {
 110         return cookie;
 111     }
 112
 113     public final ActorRef localActor() {
 114         return context.self();
 115     }
 116
 117     public final long currentTime() {
 118         return context.ticker().read();
 119     }
 120
 121     /**
 122      * Send a request to the backend and invoke a specified callback when it finishes. This method is safe to invoke
 123      * from any thread.
 124      *
 125      * <p>This method may put the caller thread to sleep in order to throttle the request rate.
 126      * The callback may be called before the sleep finishes.
 127      *
 128      * @param request Request to send
 129      * @param callback Callback to invoke
 130      */
 131     public final void sendRequest(final Request<?, ?> request, final Consumer<Response<?, ?>> callback) {
 132         final long now = currentTime();
 133         final long delay = enqueueEntry(new ConnectionEntry(request, callback, now), now);
 134         try {
 135             TimeUnit.NANOSECONDS.sleep(delay);
 136         } catch (InterruptedException e) {
 137             Thread.currentThread().interrupt();
 138             LOG.debug("Interrupted after sleeping {}ns", e, currentTime() - now);
 139         }
 140     }
 141
 142     /**
 143      * Send a request to the backend and invoke a specified callback when it finishes. This method is safe to invoke
 144      * from any thread.
 145      *
 146      * <p>
 147      * Note that unlike {@link #sendRequest(Request, Consumer)}, this method does not exert backpressure, hence it
 148      * should never be called from an application thread.
 149      *
 150      * @param request Request to send
 151      * @param callback Callback to invoke
 152      * @param enqueuedTicks Time (according to {@link #currentTime()} of request enqueue
 153      */
 154     public final void enqueueRequest(final Request<?, ?> request, final Consumer<Response<?, ?>> callback,
 155             final long enqueuedTicks) {
 156         enqueueEntry(new ConnectionEntry(request, callback, enqueuedTicks), currentTime());
 157     }
 158
 159     public abstract Optional<T> getBackendInfo();
 160
 161     final Collection<ConnectionEntry> startReplay() {
 162         lock.lock();
 163         return queue.drain();
 164     }
 165
 166     @GuardedBy("lock")
 167     final void finishReplay(final ReconnectForwarder forwarder) {
 168         setForwarder(forwarder);
 169         lock.unlock();
 170     }
 171
 172     @GuardedBy("lock")
 173     final void setForwarder(final ReconnectForwarder forwarder) {
 174         queue.setForwarder(forwarder, currentTime());
 175     }
 176
 177     @GuardedBy("lock")
 178     abstract ClientActorBehavior<T> lockedReconnect(ClientActorBehavior<T> current,
 179             RequestException runtimeRequestException);
 180
 181     final long enqueueEntry(final ConnectionEntry entry, final long now) {
 182         lock.lock();
 183         try {
 184             final RequestException maybePoison = poisoned;
 185             if (maybePoison != null) {
 186                 throw new IllegalStateException("Connection " + this + " has been poisoned", maybePoison);
 187             }
 188
 189             if (queue.isEmpty()) {
 190                 // The queue is becoming non-empty, schedule a timer.
 191                 scheduleTimer(entry.getEnqueuedTicks() + REQUEST_TIMEOUT_NANOS - now);
 192             }
 193             return queue.enqueue(entry, now);
 194         } finally {
 195             lock.unlock();
 196         }
 197     }
 198
 199     final ClientActorBehavior<T> reconnect(final ClientActorBehavior<T> current, final RequestException cause) {
 200         lock.lock();
 201         try {
 202             return lockedReconnect(current, cause);
 203         } finally {
 204             lock.unlock();
 205         }
 206     }
 207
 208     /**
 209      * Schedule a timer to fire on the actor thread after a delay.
 210      *
 211      * @param delay Delay, in nanoseconds
 212      */
 213     @GuardedBy("lock")
 214     private void scheduleTimer(final long delay) {
 215         if (haveTimer) {
 216             LOG.debug("{}: timer already scheduled", context.persistenceId());
 217             return;
 218         }
 219         if (queue.hasSuccessor()) {
 220             LOG.debug("{}: connection has successor, not scheduling timer", context.persistenceId());
 221             return;
 222         }
 223
 224         // If the delay is negative, we need to schedule an action immediately. While the caller could have checked
 225         // for that condition and take appropriate action, but this is more convenient and less error-prone.
 226         final long normalized =  delay <= 0 ? 0 : Math.min(delay, BACKEND_ALIVE_TIMEOUT_NANOS);
 227
 228         final FiniteDuration dur = FiniteDuration.fromNanos(normalized);
 229         LOG.debug("{}: scheduling timeout in {}", context.persistenceId(), dur);
 230         context.executeInActor(this::runTimer, dur);
 231         haveTimer = true;
 232     }
 233
 234     /**
 235      * Check this queue for timeout and initiate reconnection if that happened. If the queue has not made progress
 236      * in {@link #NO_PROGRESS_TIMEOUT_NANOS} nanoseconds, it will be aborted.
 237      *
 238      * @param current Current behavior
 239      * @return Next behavior to use
 240      */
 241     @VisibleForTesting
 242     final ClientActorBehavior<T> runTimer(final ClientActorBehavior<T> current) {
 243         final Optional<Long> delay;
 244
 245         lock.lock();
 246         try {
 247             haveTimer = false;
 248             final long now = currentTime();
 249             // The following line is only reliable when queue is not forwarding, but such state should not last long.
 250             // FIXME: BUG-8422: this may not be accurate w.r.t. replayed entries
 251             final long ticksSinceProgress = queue.ticksStalling(now);
 252             if (ticksSinceProgress >= NO_PROGRESS_TIMEOUT_NANOS) {
 253                 LOG.error("Queue {} has not seen progress in {} seconds, failing all requests", this,
 254                     TimeUnit.NANOSECONDS.toSeconds(ticksSinceProgress));
 255
 256                 lockedPoison(new NoProgressException(ticksSinceProgress));
 257                 current.removeConnection(this);
 258                 return current;
 259             }
 260
 261             // Requests are always scheduled in sequence, hence checking for timeout is relatively straightforward.
 262             // Note we use also inquire about the delay, so we can re-schedule if needed, hence the unusual tri-state
 263             // return convention.
 264             delay = lockedCheckTimeout(now);
 265             if (delay == null) {
 266                 // We have timed out. There is no point in scheduling a timer
 267                 return lockedReconnect(current, new RuntimeRequestException("Backend connection timed out",
 268                     new TimeoutException()));
 269             }
 270
 271             if (delay.isPresent()) {
 272                 // If there is new delay, schedule a timer
 273                 scheduleTimer(delay.get());
 274             }
 275         } finally {
 276             lock.unlock();
 277         }
 278
 279         return current;
 280     }
 281
 282     @VisibleForTesting
 283     final Optional<Long> checkTimeout(final long now) {
 284         lock.lock();
 285         try {
 286             return lockedCheckTimeout(now);
 287         } finally {
 288             lock.unlock();
 289         }
 290     }
 291
 292     long backendSilentTicks(final long now) {
 293         return now - lastReceivedTicks;
 294     }
 295
 296     /*
 297      * We are using tri-state return here to indicate one of three conditions:
 298      * - if there is no timeout to schedule, return Optional.empty()
 299      * - if there is a timeout to schedule, return a non-empty optional
 300      * - if this connections has timed out, return null
 301      */
 302     @SuppressFBWarnings(value = "NP_OPTIONAL_RETURN_NULL",
 303             justification = "Returning null Optional is documented in the API contract.")
 304     @GuardedBy("lock")
 305     private Optional<Long> lockedCheckTimeout(final long now) {
 306         if (queue.isEmpty()) {
 307             return Optional.empty();
 308         }
 309
 310         final long backendSilentTicks = backendSilentTicks(now);
 311         if (backendSilentTicks >= BACKEND_ALIVE_TIMEOUT_NANOS) {
 312             LOG.debug("Connection {} has not seen activity from backend for {} nanoseconds, timing out", this,
 313                 backendSilentTicks);
 314             return null;
 315         }
 316
 317         int tasksTimedOut = 0;
 318         for (ConnectionEntry head = queue.peek(); head != null; head = queue.peek()) {
 319             final long beenOpen = now - head.getEnqueuedTicks();
 320             if (beenOpen < REQUEST_TIMEOUT_NANOS) {
 321                 return Optional.of(REQUEST_TIMEOUT_NANOS - beenOpen);
 322             }
 323
 324             tasksTimedOut++;
 325             queue.remove(now);
 326             LOG.debug("Connection {} timed out entryt {}", this, head);
 327             head.complete(head.getRequest().toRequestFailure(
 328                 new RequestTimeoutException("Timed out after " + beenOpen + "ns")));
 329         }
 330
 331         LOG.debug("Connection {} timed out {} tasks", this, tasksTimedOut);
 332         if (tasksTimedOut != 0) {
 333             queue.tryTransmit(now);
 334         }
 335
 336         return Optional.empty();
 337     }
 338
 339     final void poison(final RequestException cause) {
 340         lock.lock();
 341         try {
 342             lockedPoison(cause);
 343         } finally {
 344             lock.unlock();
 345         }
 346     }
 347
 348     @GuardedBy("lock")
 349     private void lockedPoison(final RequestException cause) {
 350         poisoned = enrichPoison(cause);
 351         queue.poison(cause);
 352     }
 353
 354     RequestException enrichPoison(final RequestException ex) {
 355         return ex;
 356     }
 357
 358     @VisibleForTesting
 359     final RequestException poisoned() {
 360         return poisoned;
 361     }
 362
 363     final void receiveResponse(final ResponseEnvelope<?> envelope) {
 364         final long now = currentTime();
 365         lastReceivedTicks = now;
 366
 367         final Optional<TransmittedConnectionEntry> maybeEntry;
 368         lock.lock();
 369         try {
 370             maybeEntry = queue.complete(envelope, now);
 371         } finally {
 372             lock.unlock();
 373         }
 374
 375         if (maybeEntry.isPresent()) {
 376             final TransmittedConnectionEntry entry = maybeEntry.get();
 377             LOG.debug("Completing {} with {}", entry, envelope);
 378             entry.complete(envelope.getMessage());
 379         }
 380     }
 381
 382     @Override
 383     public final String toString() {
 384         return addToStringAttributes(MoreObjects.toStringHelper(this).omitNullValues()).toString();
 385     }
 386
 387     ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
 388         return toStringHelper.add("client", context.getIdentifier()).add("cookie", cookie).add("poisoned", poisoned);
 389     }
 390 }