| /* |
| * Copyright 2015, Google Inc. All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are |
| * met: |
| * |
| * * Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * * Redistributions in binary form must reproduce the above |
| * copyright notice, this list of conditions and the following disclaimer |
| * in the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * * Neither the name of Google Inc. nor the names of its |
| * contributors may be used to endorse or promote products derived from |
| * this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| */ |
| |
| package io.grpc.internal; |
| |
| import static io.grpc.ConnectivityState.CONNECTING; |
| import static io.grpc.ConnectivityState.IDLE; |
| import static io.grpc.ConnectivityState.READY; |
| import static io.grpc.ConnectivityState.SHUTDOWN; |
| |
| import com.google.common.annotations.VisibleForTesting; |
| import com.google.common.base.Preconditions; |
| import com.google.common.base.Stopwatch; |
| import com.google.common.base.Supplier; |
| import com.google.errorprone.annotations.ForOverride; |
| |
| import io.grpc.ConnectivityState; |
| import io.grpc.ConnectivityStateInfo; |
| import io.grpc.EquivalentAddressGroup; |
| import io.grpc.Status; |
| |
| import java.net.SocketAddress; |
| import java.util.ArrayList; |
| import java.util.Collection; |
| import java.util.List; |
| import java.util.concurrent.ScheduledExecutorService; |
| import java.util.concurrent.ScheduledFuture; |
| import java.util.concurrent.TimeUnit; |
| import java.util.logging.Level; |
| import java.util.logging.Logger; |
| |
| import javax.annotation.Nullable; |
| import javax.annotation.concurrent.GuardedBy; |
| import javax.annotation.concurrent.ThreadSafe; |
| |
| /** |
| * Transports for a single {@link SocketAddress}. |
| * |
| * <p>This is the next version of {@link TransportSet} in development. |
| */ |
| @ThreadSafe |
| final class InternalSubchannel implements WithLogId { |
| private static final Logger log = Logger.getLogger(InternalSubchannel.class.getName()); |
| |
| private final LogId logId = LogId.allocate(getClass().getName()); |
| private final EquivalentAddressGroup addressGroup; |
| private final String authority; |
| private final String userAgent; |
| private final BackoffPolicy.Provider backoffPolicyProvider; |
| private final Callback callback; |
| private final ClientTransportFactory transportFactory; |
| private final ScheduledExecutorService scheduledExecutor; |
| |
| // File-specific convention: methods without GuardedBy("lock") MUST NOT be called under the lock. |
| private final Object lock = new Object(); |
| |
| // File-specific convention: |
| // |
| // 1. In a method without GuardedBy("lock"), executeLater() MUST be followed by a drain() later in |
| // the same method. |
| // |
| // 2. drain() MUST NOT be called under "lock". |
| // |
| // 3. Every synchronized("lock") must be inside a try-finally which calls drain() in "finally". |
| private final ChannelExecutor channelExecutor; |
| |
| @GuardedBy("lock") |
| private int nextAddressIndex; |
| |
| /** |
| * The policy to control back off between reconnects. Non-{@code null} when last connect failed. |
| */ |
| @GuardedBy("lock") |
| private BackoffPolicy reconnectPolicy; |
| |
| /** |
| * Timer monitoring duration since entering CONNECTING state. |
| */ |
| @GuardedBy("lock") |
| private final Stopwatch connectingTimer; |
| |
| @GuardedBy("lock") |
| @Nullable |
| private ScheduledFuture<?> reconnectTask; |
| |
| /** |
| * All transports that are not terminated. At the very least the value of {@link #activeTransport} |
| * will be present, but previously used transports that still have streams or are stopping may |
| * also be present. |
| */ |
| @GuardedBy("lock") |
| private final Collection<ConnectionClientTransport> transports = |
| new ArrayList<ConnectionClientTransport>(); |
| |
| // Must only be used from channelExecutor |
| private final InUseStateAggregator2<ConnectionClientTransport> inUseStateAggregator = |
| new InUseStateAggregator2<ConnectionClientTransport>() { |
| @Override |
| void handleInUse() { |
| callback.onInUse(InternalSubchannel.this); |
| } |
| |
| @Override |
| void handleNotInUse() { |
| callback.onNotInUse(InternalSubchannel.this); |
| } |
| }; |
| |
| /** |
| * The to-be active transport, which is not ready yet. |
| */ |
| @GuardedBy("lock") |
| @Nullable |
| private ConnectionClientTransport pendingTransport; |
| |
| /** |
| * The transport for new outgoing requests. 'lock' must be held when assigning to it. Non-null |
| * only in READY state. |
| */ |
| @Nullable |
| private volatile ManagedClientTransport activeTransport; |
| |
| @GuardedBy("lock") |
| private ConnectivityStateInfo state = ConnectivityStateInfo.forNonError(IDLE); |
| |
| InternalSubchannel(EquivalentAddressGroup addressGroup, String authority, String userAgent, |
| BackoffPolicy.Provider backoffPolicyProvider, |
| ClientTransportFactory transportFactory, ScheduledExecutorService scheduledExecutor, |
| Supplier<Stopwatch> stopwatchSupplier, ChannelExecutor channelExecutor, Callback callback) { |
| this.addressGroup = Preconditions.checkNotNull(addressGroup, "addressGroup"); |
| this.authority = authority; |
| this.userAgent = userAgent; |
| this.backoffPolicyProvider = backoffPolicyProvider; |
| this.transportFactory = transportFactory; |
| this.scheduledExecutor = scheduledExecutor; |
| this.connectingTimer = stopwatchSupplier.get(); |
| this.channelExecutor = channelExecutor; |
| this.callback = callback; |
| } |
| |
| /** |
| * Returns a READY transport that will be used to create new streams. |
| * |
| * <p>Returns {@code null} if the state is not READY. Will try to connect if state is IDLE. |
| */ |
| @Nullable |
| ClientTransport obtainActiveTransport() { |
| ClientTransport savedTransport = activeTransport; |
| if (savedTransport != null) { |
| return savedTransport; |
| } |
| try { |
| synchronized (lock) { |
| savedTransport = activeTransport; |
| // Check again, since it could have changed before acquiring the lock |
| if (savedTransport != null) { |
| return savedTransport; |
| } |
| if (state.getState() == IDLE) { |
| gotoNonErrorState(CONNECTING); |
| startNewTransport(); |
| } |
| } |
| } finally { |
| channelExecutor.drain(); |
| } |
| return null; |
| } |
| |
| @GuardedBy("lock") |
| private void startNewTransport() { |
| Preconditions.checkState(reconnectTask == null, "Should have no reconnectTask scheduled"); |
| |
| if (nextAddressIndex == 0) { |
| connectingTimer.reset().start(); |
| } |
| List<SocketAddress> addrs = addressGroup.getAddresses(); |
| final SocketAddress address = addrs.get(nextAddressIndex++); |
| if (nextAddressIndex >= addrs.size()) { |
| nextAddressIndex = 0; |
| } |
| |
| ConnectionClientTransport transport = |
| transportFactory.newClientTransport(address, authority, userAgent); |
| if (log.isLoggable(Level.FINE)) { |
| log.log(Level.FINE, "[{0}] Created {1} for {2}", |
| new Object[] {logId, transport.getLogId(), address}); |
| } |
| pendingTransport = transport; |
| transports.add(transport); |
| Runnable runnable = transport.start(new TransportListener(transport, address)); |
| if (runnable != null) { |
| channelExecutor.executeLater(runnable); |
| } |
| } |
| |
| /** |
| * Only called after all addresses attempted and failed (TRANSIENT_FAILURE). |
| * @param status the causal status when the channel begins transition to |
| * TRANSIENT_FAILURE. |
| */ |
| @GuardedBy("lock") |
| private void scheduleBackoff(final Status status) { |
| class EndOfCurrentBackoff implements Runnable { |
| @Override |
| public void run() { |
| try { |
| synchronized (lock) { |
| reconnectTask = null; |
| if (state.getState() == SHUTDOWN) { |
| // Even though shutdown() will cancel this task, the task may have already started |
| // when it's being cancelled. |
| return; |
| } |
| gotoNonErrorState(CONNECTING); |
| startNewTransport(); |
| } |
| } catch (Throwable t) { |
| log.log(Level.WARNING, "Exception handling end of backoff", t); |
| } finally { |
| channelExecutor.drain(); |
| } |
| } |
| } |
| |
| gotoState(ConnectivityStateInfo.forTransientFailure(status)); |
| if (reconnectPolicy == null) { |
| reconnectPolicy = backoffPolicyProvider.get(); |
| } |
| long delayMillis = |
| reconnectPolicy.nextBackoffMillis() - connectingTimer.elapsed(TimeUnit.MILLISECONDS); |
| if (log.isLoggable(Level.FINE)) { |
| log.log(Level.FINE, "[{0}] Scheduling backoff for {1} ms", new Object[]{logId, delayMillis}); |
| } |
| Preconditions.checkState(reconnectTask == null, "previous reconnectTask is not done"); |
| reconnectTask = scheduledExecutor.schedule( |
| new LogExceptionRunnable(new EndOfCurrentBackoff()), |
| delayMillis, |
| TimeUnit.MILLISECONDS); |
| } |
| |
| @GuardedBy("lock") |
| private void gotoNonErrorState(ConnectivityState newState) { |
| gotoState(ConnectivityStateInfo.forNonError(newState)); |
| } |
| |
| @GuardedBy("lock") |
| private void gotoState(final ConnectivityStateInfo newState) { |
| if (state.getState() != newState.getState()) { |
| Preconditions.checkState(state.getState() != SHUTDOWN, |
| "Cannot transition out of SHUTDOWN to " + newState); |
| state = newState; |
| channelExecutor.executeLater(new Runnable() { |
| @Override |
| public void run() { |
| callback.onStateChange(InternalSubchannel.this, newState); |
| } |
| }); |
| } |
| } |
| |
| public void shutdown() { |
| ManagedClientTransport savedActiveTransport; |
| ConnectionClientTransport savedPendingTransport; |
| try { |
| synchronized (lock) { |
| if (state.getState() == SHUTDOWN) { |
| return; |
| } |
| gotoNonErrorState(SHUTDOWN); |
| savedActiveTransport = activeTransport; |
| savedPendingTransport = pendingTransport; |
| activeTransport = null; |
| pendingTransport = null; |
| if (transports.isEmpty()) { |
| handleTermination(); |
| if (log.isLoggable(Level.FINE)) { |
| log.log(Level.FINE, "[{0}] Terminated in shutdown()", logId); |
| } |
| } // else: the callback will be run once all transports have been terminated |
| cancelReconnectTask(); |
| } |
| } finally { |
| channelExecutor.drain(); |
| } |
| if (savedActiveTransport != null) { |
| savedActiveTransport.shutdown(); |
| } |
| if (savedPendingTransport != null) { |
| savedPendingTransport.shutdown(); |
| } |
| } |
| |
| @GuardedBy("lock") |
| private void handleTermination() { |
| channelExecutor.executeLater(new Runnable() { |
| @Override |
| public void run() { |
| callback.onTerminated(InternalSubchannel.this); |
| } |
| }); |
| } |
| |
| private void handleTransportInUseState( |
| final ConnectionClientTransport transport, final boolean inUse) { |
| channelExecutor.executeLater(new Runnable() { |
| @Override |
| public void run() { |
| inUseStateAggregator.updateObjectInUse(transport, inUse); |
| } |
| }).drain(); |
| } |
| |
| void shutdownNow(Status reason) { |
| shutdown(); |
| Collection<ManagedClientTransport> transportsCopy; |
| try { |
| synchronized (lock) { |
| transportsCopy = new ArrayList<ManagedClientTransport>(transports); |
| } |
| } finally { |
| channelExecutor.drain(); |
| } |
| for (ManagedClientTransport transport : transportsCopy) { |
| transport.shutdownNow(reason); |
| } |
| } |
| |
| EquivalentAddressGroup getAddressGroup() { |
| return addressGroup; |
| } |
| |
| @GuardedBy("lock") |
| private void cancelReconnectTask() { |
| if (reconnectTask != null) { |
| reconnectTask.cancel(false); |
| reconnectTask = null; |
| } |
| } |
| |
| @Override |
| public LogId getLogId() { |
| return logId; |
| } |
| |
| @VisibleForTesting |
| ConnectivityState getState() { |
| try { |
| synchronized (lock) { |
| return state.getState(); |
| } |
| } finally { |
| channelExecutor.drain(); |
| } |
| } |
| |
| /** Listener for real transports. */ |
| private class TransportListener implements ManagedClientTransport.Listener { |
| final ConnectionClientTransport transport; |
| final SocketAddress address; |
| |
| TransportListener(ConnectionClientTransport transport, SocketAddress address) { |
| this.transport = transport; |
| this.address = address; |
| } |
| |
| @Override |
| public void transportReady() { |
| if (log.isLoggable(Level.FINE)) { |
| log.log(Level.FINE, "[{0}] {1} for {2} is ready", |
| new Object[] {logId, transport.getLogId(), address}); |
| } |
| ConnectivityState savedState; |
| try { |
| synchronized (lock) { |
| savedState = state.getState(); |
| reconnectPolicy = null; |
| nextAddressIndex = 0; |
| if (savedState == SHUTDOWN) { |
| // activeTransport should have already been set to null by shutdown(). We keep it null. |
| Preconditions.checkState(activeTransport == null, |
| "Unexpected non-null activeTransport"); |
| } else if (pendingTransport == transport) { |
| gotoNonErrorState(READY); |
| activeTransport = transport; |
| pendingTransport = null; |
| } |
| } |
| } finally { |
| channelExecutor.drain(); |
| } |
| if (savedState == SHUTDOWN) { |
| transport.shutdown(); |
| } |
| } |
| |
| @Override |
| public void transportInUse(boolean inUse) { |
| handleTransportInUseState(transport, inUse); |
| } |
| |
| @Override |
| public void transportShutdown(Status s) { |
| if (log.isLoggable(Level.FINE)) { |
| log.log(Level.FINE, "[{0}] {1} for {2} is being shutdown with status {3}", |
| new Object[] {logId, transport.getLogId(), address, s}); |
| } |
| try { |
| synchronized (lock) { |
| if (state.getState() == SHUTDOWN) { |
| return; |
| } |
| if (activeTransport == transport) { |
| gotoNonErrorState(IDLE); |
| activeTransport = null; |
| } else if (pendingTransport == transport) { |
| Preconditions.checkState(state.getState() == CONNECTING, |
| "Expected state is CONNECTING, actual state is %s", state.getState()); |
| // Continue reconnect if there are still addresses to try. |
| if (nextAddressIndex == 0) { |
| // Initiate backoff |
| // Transition to TRANSIENT_FAILURE |
| scheduleBackoff(s); |
| } else { |
| startNewTransport(); |
| } |
| } |
| } |
| } finally { |
| channelExecutor.drain(); |
| } |
| } |
| |
| @Override |
| public void transportTerminated() { |
| if (log.isLoggable(Level.FINE)) { |
| log.log(Level.FINE, "[{0}] {1} for {2} is terminated", |
| new Object[] {logId, transport.getLogId(), address}); |
| } |
| handleTransportInUseState(transport, false); |
| try { |
| synchronized (lock) { |
| transports.remove(transport); |
| if (state.getState() == SHUTDOWN && transports.isEmpty()) { |
| if (log.isLoggable(Level.FINE)) { |
| log.log(Level.FINE, "[{0}] Terminated in transportTerminated()", logId); |
| } |
| handleTermination(); |
| } |
| } |
| } finally { |
| channelExecutor.drain(); |
| } |
| Preconditions.checkState(activeTransport != transport, |
| "activeTransport still points to this transport. " |
| + "Seems transportShutdown() was not called."); |
| } |
| } |
| |
| // All methods are called in channelExecutor, which is a serializing executor. |
| abstract static class Callback { |
| /** |
| * Called when the subchannel is terminated, which means it's shut down and all transports |
| * have been terminated. |
| */ |
| @ForOverride |
| void onTerminated(InternalSubchannel is) { } |
| |
| /** |
| * Called when the subchannel's connectivity state has changed. |
| */ |
| @ForOverride |
| void onStateChange(InternalSubchannel is, ConnectivityStateInfo newState) { } |
| |
| /** |
| * Called when the subchannel's in-use state has changed to true, which means at least one |
| * transport is in use. |
| */ |
| @ForOverride |
| void onInUse(InternalSubchannel is) { } |
| |
| /** |
| * Called when the subchannel's in-use state has changed to false, which means no transport is |
| * in use. |
| */ |
| @ForOverride |
| void onNotInUse(InternalSubchannel is) { } |
| } |
| } |