• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

grpc / grpc-java / #19510

16 Oct 2024 08:26PM UTC coverage: 84.654% (-0.003%) from 84.657%
#19510

push

github

ejona86
core: Handle NR/LB exceptions when panicking

If a panic is followed a panic, we'd ignore the second. But if an
exception happens while entering panic mode we may fail to update the
picker with the first error. This is "fine" from a correctness
standpoint; all bets are off when panicking and we've already logged the
first error. But failing RPCs can often be more easily seen than just
the log.

Noticed because of http://yaqs/8493785598685872128

33815 of 39945 relevant lines covered (84.65%)

0.85 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.02
/../core/src/main/java/io/grpc/internal/ManagedChannelImpl.java
1
/*
2
 * Copyright 2016 The gRPC Authors
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
package io.grpc.internal;
18

19
import static com.google.common.base.Preconditions.checkArgument;
20
import static com.google.common.base.Preconditions.checkNotNull;
21
import static com.google.common.base.Preconditions.checkState;
22
import static io.grpc.ClientStreamTracer.NAME_RESOLUTION_DELAYED;
23
import static io.grpc.ConnectivityState.CONNECTING;
24
import static io.grpc.ConnectivityState.IDLE;
25
import static io.grpc.ConnectivityState.SHUTDOWN;
26
import static io.grpc.ConnectivityState.TRANSIENT_FAILURE;
27
import static io.grpc.EquivalentAddressGroup.ATTR_AUTHORITY_OVERRIDE;
28

29
import com.google.common.annotations.VisibleForTesting;
30
import com.google.common.base.MoreObjects;
31
import com.google.common.base.Stopwatch;
32
import com.google.common.base.Supplier;
33
import com.google.common.util.concurrent.ListenableFuture;
34
import com.google.common.util.concurrent.SettableFuture;
35
import io.grpc.Attributes;
36
import io.grpc.CallCredentials;
37
import io.grpc.CallOptions;
38
import io.grpc.Channel;
39
import io.grpc.ChannelCredentials;
40
import io.grpc.ChannelLogger;
41
import io.grpc.ChannelLogger.ChannelLogLevel;
42
import io.grpc.ClientCall;
43
import io.grpc.ClientInterceptor;
44
import io.grpc.ClientInterceptors;
45
import io.grpc.ClientStreamTracer;
46
import io.grpc.ClientTransportFilter;
47
import io.grpc.CompressorRegistry;
48
import io.grpc.ConnectivityState;
49
import io.grpc.ConnectivityStateInfo;
50
import io.grpc.Context;
51
import io.grpc.Deadline;
52
import io.grpc.DecompressorRegistry;
53
import io.grpc.EquivalentAddressGroup;
54
import io.grpc.ForwardingChannelBuilder2;
55
import io.grpc.ForwardingClientCall;
56
import io.grpc.Grpc;
57
import io.grpc.InternalChannelz;
58
import io.grpc.InternalChannelz.ChannelStats;
59
import io.grpc.InternalChannelz.ChannelTrace;
60
import io.grpc.InternalConfigSelector;
61
import io.grpc.InternalInstrumented;
62
import io.grpc.InternalLogId;
63
import io.grpc.InternalWithLogId;
64
import io.grpc.LoadBalancer;
65
import io.grpc.LoadBalancer.CreateSubchannelArgs;
66
import io.grpc.LoadBalancer.PickResult;
67
import io.grpc.LoadBalancer.PickSubchannelArgs;
68
import io.grpc.LoadBalancer.ResolvedAddresses;
69
import io.grpc.LoadBalancer.SubchannelPicker;
70
import io.grpc.LoadBalancer.SubchannelStateListener;
71
import io.grpc.ManagedChannel;
72
import io.grpc.ManagedChannelBuilder;
73
import io.grpc.Metadata;
74
import io.grpc.MethodDescriptor;
75
import io.grpc.MetricInstrumentRegistry;
76
import io.grpc.MetricRecorder;
77
import io.grpc.NameResolver;
78
import io.grpc.NameResolver.ConfigOrError;
79
import io.grpc.NameResolver.ResolutionResult;
80
import io.grpc.NameResolverProvider;
81
import io.grpc.NameResolverRegistry;
82
import io.grpc.ProxyDetector;
83
import io.grpc.Status;
84
import io.grpc.StatusOr;
85
import io.grpc.SynchronizationContext;
86
import io.grpc.SynchronizationContext.ScheduledHandle;
87
import io.grpc.internal.AutoConfiguredLoadBalancerFactory.AutoConfiguredLoadBalancer;
88
import io.grpc.internal.ClientCallImpl.ClientStreamProvider;
89
import io.grpc.internal.ClientTransportFactory.SwapChannelCredentialsResult;
90
import io.grpc.internal.ManagedChannelImplBuilder.ClientTransportFactoryBuilder;
91
import io.grpc.internal.ManagedChannelImplBuilder.FixedPortProvider;
92
import io.grpc.internal.ManagedChannelServiceConfig.MethodInfo;
93
import io.grpc.internal.ManagedChannelServiceConfig.ServiceConfigConvertedSelector;
94
import io.grpc.internal.RetriableStream.ChannelBufferMeter;
95
import io.grpc.internal.RetriableStream.Throttle;
96
import io.grpc.internal.RetryingNameResolver.ResolutionResultListener;
97
import java.net.URI;
98
import java.util.ArrayList;
99
import java.util.Collection;
100
import java.util.Collections;
101
import java.util.HashSet;
102
import java.util.LinkedHashSet;
103
import java.util.List;
104
import java.util.Map;
105
import java.util.Set;
106
import java.util.concurrent.Callable;
107
import java.util.concurrent.CountDownLatch;
108
import java.util.concurrent.ExecutionException;
109
import java.util.concurrent.Executor;
110
import java.util.concurrent.Future;
111
import java.util.concurrent.ScheduledExecutorService;
112
import java.util.concurrent.ScheduledFuture;
113
import java.util.concurrent.TimeUnit;
114
import java.util.concurrent.TimeoutException;
115
import java.util.concurrent.atomic.AtomicBoolean;
116
import java.util.concurrent.atomic.AtomicReference;
117
import java.util.logging.Level;
118
import java.util.logging.Logger;
119
import javax.annotation.Nullable;
120
import javax.annotation.concurrent.GuardedBy;
121
import javax.annotation.concurrent.ThreadSafe;
122

123
/** A communication channel for making outgoing RPCs. */
124
@ThreadSafe
125
final class ManagedChannelImpl extends ManagedChannel implements
126
    InternalInstrumented<ChannelStats> {
127
  @VisibleForTesting
128
  static final Logger logger = Logger.getLogger(ManagedChannelImpl.class.getName());
1✔
129

130
  static final long IDLE_TIMEOUT_MILLIS_DISABLE = -1;
131

132
  static final long SUBCHANNEL_SHUTDOWN_DELAY_SECONDS = 5;
133

134
  @VisibleForTesting
135
  static final Status SHUTDOWN_NOW_STATUS =
1✔
136
      Status.UNAVAILABLE.withDescription("Channel shutdownNow invoked");
1✔
137

138
  @VisibleForTesting
139
  static final Status SHUTDOWN_STATUS =
1✔
140
      Status.UNAVAILABLE.withDescription("Channel shutdown invoked");
1✔
141

142
  @VisibleForTesting
143
  static final Status SUBCHANNEL_SHUTDOWN_STATUS =
1✔
144
      Status.UNAVAILABLE.withDescription("Subchannel shutdown invoked");
1✔
145

146
  private static final ManagedChannelServiceConfig EMPTY_SERVICE_CONFIG =
147
      ManagedChannelServiceConfig.empty();
1✔
148
  private static final InternalConfigSelector INITIAL_PENDING_SELECTOR =
1✔
149
      new InternalConfigSelector() {
1✔
150
        @Override
151
        public Result selectConfig(PickSubchannelArgs args) {
152
          throw new IllegalStateException("Resolution is pending");
×
153
        }
154
      };
155
  private static final LoadBalancer.PickDetailsConsumer NOOP_PICK_DETAILS_CONSUMER =
1✔
156
      new LoadBalancer.PickDetailsConsumer() {};
1✔
157

158
  private final InternalLogId logId;
159
  private final String target;
160
  @Nullable
161
  private final String authorityOverride;
162
  private final NameResolverRegistry nameResolverRegistry;
163
  private final URI targetUri;
164
  private final NameResolverProvider nameResolverProvider;
165
  private final NameResolver.Args nameResolverArgs;
166
  private final AutoConfiguredLoadBalancerFactory loadBalancerFactory;
167
  private final ClientTransportFactory originalTransportFactory;
168
  @Nullable
169
  private final ChannelCredentials originalChannelCreds;
170
  private final ClientTransportFactory transportFactory;
171
  private final ClientTransportFactory oobTransportFactory;
172
  private final RestrictedScheduledExecutor scheduledExecutor;
173
  private final Executor executor;
174
  private final ObjectPool<? extends Executor> executorPool;
175
  private final ObjectPool<? extends Executor> balancerRpcExecutorPool;
176
  private final ExecutorHolder balancerRpcExecutorHolder;
177
  private final ExecutorHolder offloadExecutorHolder;
178
  private final TimeProvider timeProvider;
179
  private final int maxTraceEvents;
180

181
  @VisibleForTesting
1✔
182
  final SynchronizationContext syncContext = new SynchronizationContext(
183
      new Thread.UncaughtExceptionHandler() {
1✔
184
        @Override
185
        public void uncaughtException(Thread t, Throwable e) {
186
          logger.log(
1✔
187
              Level.SEVERE,
188
              "[" + getLogId() + "] Uncaught exception in the SynchronizationContext. Panic!",
1✔
189
              e);
190
          panic(e);
1✔
191
        }
1✔
192
      });
193

194
  private boolean fullStreamDecompression;
195

196
  private final DecompressorRegistry decompressorRegistry;
197
  private final CompressorRegistry compressorRegistry;
198

199
  private final Supplier<Stopwatch> stopwatchSupplier;
200
  /** The timeout before entering idle mode. */
201
  private final long idleTimeoutMillis;
202

203
  private final ConnectivityStateManager channelStateManager = new ConnectivityStateManager();
1✔
204
  private final BackoffPolicy.Provider backoffPolicyProvider;
205

206
  /**
207
   * We delegate to this channel, so that we can have interceptors as necessary. If there aren't
208
   * any interceptors and the {@link io.grpc.BinaryLog} is {@code null} then this will just be a
209
   * {@link RealChannel}.
210
   */
211
  private final Channel interceptorChannel;
212

213
  private final List<ClientTransportFilter> transportFilters;
214
  @Nullable private final String userAgent;
215

216
  // Only null after channel is terminated. Must be assigned from the syncContext.
217
  private NameResolver nameResolver;
218

219
  // Must be accessed from the syncContext.
220
  private boolean nameResolverStarted;
221

222
  // null when channel is in idle mode.  Must be assigned from syncContext.
223
  @Nullable
224
  private LbHelperImpl lbHelper;
225

226
  // Must ONLY be assigned from updateSubchannelPicker(), which is called from syncContext.
227
  // null if channel is in idle mode.
228
  @Nullable
229
  private volatile SubchannelPicker subchannelPicker;
230

231
  // Must be accessed from the syncContext
232
  private boolean panicMode;
233

234
  // Must be mutated from syncContext
235
  // If any monitoring hook to be added later needs to get a snapshot of this Set, we could
236
  // switch to a ConcurrentHashMap.
237
  private final Set<InternalSubchannel> subchannels = new HashSet<>(16, .75f);
1✔
238

239
  // Must be accessed from syncContext
240
  @Nullable
241
  private Collection<RealChannel.PendingCall<?, ?>> pendingCalls;
242
  private final Object pendingCallsInUseObject = new Object();
1✔
243

244
  // Must be mutated from syncContext
245
  private final Set<OobChannel> oobChannels = new HashSet<>(1, .75f);
1✔
246

247
  // reprocess() must be run from syncContext
248
  private final DelayedClientTransport delayedTransport;
249
  private final UncommittedRetriableStreamsRegistry uncommittedRetriableStreamsRegistry
1✔
250
      = new UncommittedRetriableStreamsRegistry();
251

252
  // Shutdown states.
253
  //
254
  // Channel's shutdown process:
255
  // 1. shutdown(): stop accepting new calls from applications
256
  //   1a shutdown <- true
257
  //   1b subchannelPicker <- null
258
  //   1c delayedTransport.shutdown()
259
  // 2. delayedTransport terminated: stop stream-creation functionality
260
  //   2a terminating <- true
261
  //   2b loadBalancer.shutdown()
262
  //     * LoadBalancer will shutdown subchannels and OOB channels
263
  //   2c loadBalancer <- null
264
  //   2d nameResolver.shutdown()
265
  //   2e nameResolver <- null
266
  // 3. All subchannels and OOB channels terminated: Channel considered terminated
267

268
  private final AtomicBoolean shutdown = new AtomicBoolean(false);
1✔
269
  // Must only be mutated and read from syncContext
270
  private boolean shutdownNowed;
271
  // Must only be mutated from syncContext
272
  private boolean terminating;
273
  // Must be mutated from syncContext
274
  private volatile boolean terminated;
275
  private final CountDownLatch terminatedLatch = new CountDownLatch(1);
1✔
276

277
  private final CallTracer.Factory callTracerFactory;
278
  private final CallTracer channelCallTracer;
279
  private final ChannelTracer channelTracer;
280
  private final ChannelLogger channelLogger;
281
  private final InternalChannelz channelz;
282
  private final RealChannel realChannel;
283
  // Must be mutated and read from syncContext
284
  // a flag for doing channel tracing when flipped
285
  private ResolutionState lastResolutionState = ResolutionState.NO_RESOLUTION;
1✔
286
  // Must be mutated and read from constructor or syncContext
287
  // used for channel tracing when value changed
288
  private ManagedChannelServiceConfig lastServiceConfig = EMPTY_SERVICE_CONFIG;
1✔
289

290
  @Nullable
291
  private final ManagedChannelServiceConfig defaultServiceConfig;
292
  // Must be mutated and read from constructor or syncContext
293
  private boolean serviceConfigUpdated = false;
1✔
294
  private final boolean lookUpServiceConfig;
295

296
  // One instance per channel.
297
  private final ChannelBufferMeter channelBufferUsed = new ChannelBufferMeter();
1✔
298

299
  private final long perRpcBufferLimit;
300
  private final long channelBufferLimit;
301

302
  // Temporary false flag that can skip the retry code path.
303
  private final boolean retryEnabled;
304

305
  private final Deadline.Ticker ticker = Deadline.getSystemTicker();
1✔
306

307
  // Called from syncContext
308
  private final ManagedClientTransport.Listener delayedTransportListener =
1✔
309
      new DelayedTransportListener();
310

311
  // Must be called from syncContext
312
  private void maybeShutdownNowSubchannels() {
313
    if (shutdownNowed) {
1✔
314
      for (InternalSubchannel subchannel : subchannels) {
1✔
315
        subchannel.shutdownNow(SHUTDOWN_NOW_STATUS);
1✔
316
      }
1✔
317
      for (OobChannel oobChannel : oobChannels) {
1✔
318
        oobChannel.getInternalSubchannel().shutdownNow(SHUTDOWN_NOW_STATUS);
1✔
319
      }
1✔
320
    }
321
  }
1✔
322

323
  // Must be accessed from syncContext
324
  @VisibleForTesting
1✔
325
  final InUseStateAggregator<Object> inUseStateAggregator = new IdleModeStateAggregator();
326

327
  @Override
328
  public ListenableFuture<ChannelStats> getStats() {
329
    final SettableFuture<ChannelStats> ret = SettableFuture.create();
1✔
330
    final class StatsFetcher implements Runnable {
1✔
331
      @Override
332
      public void run() {
333
        ChannelStats.Builder builder = new InternalChannelz.ChannelStats.Builder();
1✔
334
        channelCallTracer.updateBuilder(builder);
1✔
335
        channelTracer.updateBuilder(builder);
1✔
336
        builder.setTarget(target).setState(channelStateManager.getState());
1✔
337
        List<InternalWithLogId> children = new ArrayList<>();
1✔
338
        children.addAll(subchannels);
1✔
339
        children.addAll(oobChannels);
1✔
340
        builder.setSubchannels(children);
1✔
341
        ret.set(builder.build());
1✔
342
      }
1✔
343
    }
344

345
    // subchannels and oobchannels can only be accessed from syncContext
346
    syncContext.execute(new StatsFetcher());
1✔
347
    return ret;
1✔
348
  }
349

350
  @Override
351
  public InternalLogId getLogId() {
352
    return logId;
1✔
353
  }
354

355
  // Run from syncContext
356
  private class IdleModeTimer implements Runnable {
1✔
357

358
    @Override
359
    public void run() {
360
      // Workaround timer scheduled while in idle mode. This can happen from handleNotInUse() after
361
      // an explicit enterIdleMode() by the user. Protecting here as other locations are a bit too
362
      // subtle to change rapidly to resolve the channel panic. See #8714
363
      if (lbHelper == null) {
1✔
364
        return;
×
365
      }
366
      enterIdleMode();
1✔
367
    }
1✔
368
  }
369

370
  // Must be called from syncContext
371
  private void shutdownNameResolverAndLoadBalancer(boolean channelIsActive) {
372
    syncContext.throwIfNotInThisSynchronizationContext();
1✔
373
    if (channelIsActive) {
1✔
374
      checkState(nameResolverStarted, "nameResolver is not started");
1✔
375
      checkState(lbHelper != null, "lbHelper is null");
1✔
376
    }
377
    if (nameResolver != null) {
1✔
378
      nameResolver.shutdown();
1✔
379
      nameResolverStarted = false;
1✔
380
      if (channelIsActive) {
1✔
381
        nameResolver = getNameResolver(
1✔
382
            targetUri, authorityOverride, nameResolverProvider, nameResolverArgs);
383
      } else {
384
        nameResolver = null;
1✔
385
      }
386
    }
387
    if (lbHelper != null) {
1✔
388
      lbHelper.lb.shutdown();
1✔
389
      lbHelper = null;
1✔
390
    }
391
    subchannelPicker = null;
1✔
392
  }
1✔
393

394
  /**
395
   * Make the channel exit idle mode, if it's in it.
396
   *
397
   * <p>Must be called from syncContext
398
   */
399
  @VisibleForTesting
400
  void exitIdleMode() {
401
    syncContext.throwIfNotInThisSynchronizationContext();
1✔
402
    if (shutdown.get() || panicMode) {
1✔
403
      return;
1✔
404
    }
405
    if (inUseStateAggregator.isInUse()) {
1✔
406
      // Cancel the timer now, so that a racing due timer will not put Channel on idleness
407
      // when the caller of exitIdleMode() is about to use the returned loadBalancer.
408
      cancelIdleTimer(false);
1✔
409
    } else {
410
      // exitIdleMode() may be called outside of inUseStateAggregator.handleNotInUse() while
411
      // isInUse() == false, in which case we still need to schedule the timer.
412
      rescheduleIdleTimer();
1✔
413
    }
414
    if (lbHelper != null) {
1✔
415
      return;
1✔
416
    }
417
    channelLogger.log(ChannelLogLevel.INFO, "Exiting idle mode");
1✔
418
    LbHelperImpl lbHelper = new LbHelperImpl();
1✔
419
    lbHelper.lb = loadBalancerFactory.newLoadBalancer(lbHelper);
1✔
420
    // Delay setting lbHelper until fully initialized, since loadBalancerFactory is user code and
421
    // may throw. We don't want to confuse our state, even if we will enter panic mode.
422
    this.lbHelper = lbHelper;
1✔
423

424
    channelStateManager.gotoState(CONNECTING);
1✔
425
    NameResolverListener listener = new NameResolverListener(lbHelper, nameResolver);
1✔
426
    nameResolver.start(listener);
1✔
427
    nameResolverStarted = true;
1✔
428
  }
1✔
429

430
  // Must be run from syncContext
431
  private void enterIdleMode() {
432
    // nameResolver and loadBalancer are guaranteed to be non-null.  If any of them were null,
433
    // either the idleModeTimer ran twice without exiting the idle mode, or the task in shutdown()
434
    // did not cancel idleModeTimer, or enterIdle() ran while shutdown or in idle, all of
435
    // which are bugs.
436
    shutdownNameResolverAndLoadBalancer(true);
1✔
437
    delayedTransport.reprocess(null);
1✔
438
    channelLogger.log(ChannelLogLevel.INFO, "Entering IDLE state");
1✔
439
    channelStateManager.gotoState(IDLE);
1✔
440
    // If the inUseStateAggregator still considers pending calls to be queued up or the delayed
441
    // transport to be holding some we need to exit idle mode to give these calls a chance to
442
    // be processed.
443
    if (inUseStateAggregator.anyObjectInUse(pendingCallsInUseObject, delayedTransport)) {
1✔
444
      exitIdleMode();
1✔
445
    }
446
  }
1✔
447

448
  // Must be run from syncContext
449
  private void cancelIdleTimer(boolean permanent) {
450
    idleTimer.cancel(permanent);
1✔
451
  }
1✔
452

453
  // Always run from syncContext
454
  private void rescheduleIdleTimer() {
455
    if (idleTimeoutMillis == IDLE_TIMEOUT_MILLIS_DISABLE) {
1✔
456
      return;
1✔
457
    }
458
    idleTimer.reschedule(idleTimeoutMillis, TimeUnit.MILLISECONDS);
1✔
459
  }
1✔
460

461
  /**
462
   * Force name resolution refresh to happen immediately. Must be run
463
   * from syncContext.
464
   */
465
  private void refreshNameResolution() {
466
    syncContext.throwIfNotInThisSynchronizationContext();
1✔
467
    if (nameResolverStarted) {
1✔
468
      nameResolver.refresh();
1✔
469
    }
470
  }
1✔
471

472
  private final class ChannelStreamProvider implements ClientStreamProvider {
1✔
473
    volatile Throttle throttle;
474

475
    @Override
476
    public ClientStream newStream(
477
        final MethodDescriptor<?, ?> method,
478
        final CallOptions callOptions,
479
        final Metadata headers,
480
        final Context context) {
481
      // There is no need to reschedule the idle timer here. If the channel isn't shut down, either
482
      // the delayed transport or a real transport will go in-use and cancel the idle timer.
483
      if (!retryEnabled) {
1✔
484
        ClientStreamTracer[] tracers = GrpcUtil.getClientStreamTracers(
1✔
485
            callOptions, headers, 0, /* isTransparentRetry= */ false);
486
        Context origContext = context.attach();
1✔
487
        try {
488
          return delayedTransport.newStream(method, headers, callOptions, tracers);
1✔
489
        } finally {
490
          context.detach(origContext);
1✔
491
        }
492
      } else {
493
        MethodInfo methodInfo = callOptions.getOption(MethodInfo.KEY);
1✔
494
        final RetryPolicy retryPolicy = methodInfo == null ? null : methodInfo.retryPolicy;
1✔
495
        final HedgingPolicy hedgingPolicy = methodInfo == null ? null : methodInfo.hedgingPolicy;
1✔
496
        final class RetryStream<ReqT> extends RetriableStream<ReqT> {
497
          @SuppressWarnings("unchecked")
498
          RetryStream() {
1✔
499
            super(
1✔
500
                (MethodDescriptor<ReqT, ?>) method,
501
                headers,
502
                channelBufferUsed,
1✔
503
                perRpcBufferLimit,
1✔
504
                channelBufferLimit,
1✔
505
                getCallExecutor(callOptions),
1✔
506
                transportFactory.getScheduledExecutorService(),
1✔
507
                retryPolicy,
508
                hedgingPolicy,
509
                throttle);
510
          }
1✔
511

512
          @Override
513
          Status prestart() {
514
            return uncommittedRetriableStreamsRegistry.add(this);
1✔
515
          }
516

517
          @Override
518
          void postCommit() {
519
            uncommittedRetriableStreamsRegistry.remove(this);
1✔
520
          }
1✔
521

522
          @Override
523
          ClientStream newSubstream(
524
              Metadata newHeaders, ClientStreamTracer.Factory factory, int previousAttempts,
525
              boolean isTransparentRetry) {
526
            CallOptions newOptions = callOptions.withStreamTracerFactory(factory);
1✔
527
            ClientStreamTracer[] tracers = GrpcUtil.getClientStreamTracers(
1✔
528
                newOptions, newHeaders, previousAttempts, isTransparentRetry);
529
            Context origContext = context.attach();
1✔
530
            try {
531
              return delayedTransport.newStream(method, newHeaders, newOptions, tracers);
1✔
532
            } finally {
533
              context.detach(origContext);
1✔
534
            }
535
          }
536
        }
537

538
        return new RetryStream<>();
1✔
539
      }
540
    }
541
  }
542

543
  private final ChannelStreamProvider transportProvider = new ChannelStreamProvider();
1✔
544

545
  private final Rescheduler idleTimer;
546
  private final MetricRecorder metricRecorder;
547

548
  ManagedChannelImpl(
549
      ManagedChannelImplBuilder builder,
550
      ClientTransportFactory clientTransportFactory,
551
      URI targetUri,
552
      NameResolverProvider nameResolverProvider,
553
      BackoffPolicy.Provider backoffPolicyProvider,
554
      ObjectPool<? extends Executor> balancerRpcExecutorPool,
555
      Supplier<Stopwatch> stopwatchSupplier,
556
      List<ClientInterceptor> interceptors,
557
      final TimeProvider timeProvider) {
1✔
558
    this.target = checkNotNull(builder.target, "target");
1✔
559
    this.logId = InternalLogId.allocate("Channel", target);
1✔
560
    this.timeProvider = checkNotNull(timeProvider, "timeProvider");
1✔
561
    this.executorPool = checkNotNull(builder.executorPool, "executorPool");
1✔
562
    this.executor = checkNotNull(executorPool.getObject(), "executor");
1✔
563
    this.originalChannelCreds = builder.channelCredentials;
1✔
564
    this.originalTransportFactory = clientTransportFactory;
1✔
565
    this.offloadExecutorHolder =
1✔
566
        new ExecutorHolder(checkNotNull(builder.offloadExecutorPool, "offloadExecutorPool"));
1✔
567
    this.transportFactory = new CallCredentialsApplyingTransportFactory(
1✔
568
        clientTransportFactory, builder.callCredentials, this.offloadExecutorHolder);
569
    this.oobTransportFactory = new CallCredentialsApplyingTransportFactory(
1✔
570
        clientTransportFactory, null, this.offloadExecutorHolder);
571
    this.scheduledExecutor =
1✔
572
        new RestrictedScheduledExecutor(transportFactory.getScheduledExecutorService());
1✔
573
    maxTraceEvents = builder.maxTraceEvents;
1✔
574
    channelTracer = new ChannelTracer(
1✔
575
        logId, builder.maxTraceEvents, timeProvider.currentTimeNanos(),
1✔
576
        "Channel for '" + target + "'");
577
    channelLogger = new ChannelLoggerImpl(channelTracer, timeProvider);
1✔
578
    ProxyDetector proxyDetector =
579
        builder.proxyDetector != null ? builder.proxyDetector : GrpcUtil.DEFAULT_PROXY_DETECTOR;
1✔
580
    this.retryEnabled = builder.retryEnabled;
1✔
581
    this.loadBalancerFactory = new AutoConfiguredLoadBalancerFactory(builder.defaultLbPolicy);
1✔
582
    this.nameResolverRegistry = builder.nameResolverRegistry;
1✔
583
    this.targetUri = checkNotNull(targetUri, "targetUri");
1✔
584
    this.nameResolverProvider = checkNotNull(nameResolverProvider, "nameResolverProvider");
1✔
585
    ScParser serviceConfigParser =
1✔
586
        new ScParser(
587
            retryEnabled,
588
            builder.maxRetryAttempts,
589
            builder.maxHedgedAttempts,
590
            loadBalancerFactory);
591
    this.authorityOverride = builder.authorityOverride;
1✔
592
    this.nameResolverArgs =
1✔
593
        NameResolver.Args.newBuilder()
1✔
594
            .setDefaultPort(builder.getDefaultPort())
1✔
595
            .setProxyDetector(proxyDetector)
1✔
596
            .setSynchronizationContext(syncContext)
1✔
597
            .setScheduledExecutorService(scheduledExecutor)
1✔
598
            .setServiceConfigParser(serviceConfigParser)
1✔
599
            .setChannelLogger(channelLogger)
1✔
600
            .setOffloadExecutor(this.offloadExecutorHolder)
1✔
601
            .setOverrideAuthority(this.authorityOverride)
1✔
602
            .build();
1✔
603
    this.nameResolver = getNameResolver(
1✔
604
        targetUri, authorityOverride, nameResolverProvider, nameResolverArgs);
605
    this.balancerRpcExecutorPool = checkNotNull(balancerRpcExecutorPool, "balancerRpcExecutorPool");
1✔
606
    this.balancerRpcExecutorHolder = new ExecutorHolder(balancerRpcExecutorPool);
1✔
607
    this.delayedTransport = new DelayedClientTransport(this.executor, this.syncContext);
1✔
608
    this.delayedTransport.start(delayedTransportListener);
1✔
609
    this.backoffPolicyProvider = backoffPolicyProvider;
1✔
610

611
    if (builder.defaultServiceConfig != null) {
1✔
612
      ConfigOrError parsedDefaultServiceConfig =
1✔
613
          serviceConfigParser.parseServiceConfig(builder.defaultServiceConfig);
1✔
614
      checkState(
1✔
615
          parsedDefaultServiceConfig.getError() == null,
1✔
616
          "Default config is invalid: %s",
617
          parsedDefaultServiceConfig.getError());
1✔
618
      this.defaultServiceConfig =
1✔
619
          (ManagedChannelServiceConfig) parsedDefaultServiceConfig.getConfig();
1✔
620
      this.transportProvider.throttle = this.defaultServiceConfig.getRetryThrottling();
1✔
621
    } else {
1✔
622
      this.defaultServiceConfig = null;
1✔
623
    }
624
    this.lookUpServiceConfig = builder.lookUpServiceConfig;
1✔
625
    realChannel = new RealChannel(nameResolver.getServiceAuthority());
1✔
626
    Channel channel = realChannel;
1✔
627
    if (builder.binlog != null) {
1✔
628
      channel = builder.binlog.wrapChannel(channel);
1✔
629
    }
630
    this.interceptorChannel = ClientInterceptors.intercept(channel, interceptors);
1✔
631
    this.transportFilters = new ArrayList<>(builder.transportFilters);
1✔
632
    this.stopwatchSupplier = checkNotNull(stopwatchSupplier, "stopwatchSupplier");
1✔
633
    if (builder.idleTimeoutMillis == IDLE_TIMEOUT_MILLIS_DISABLE) {
1✔
634
      this.idleTimeoutMillis = builder.idleTimeoutMillis;
1✔
635
    } else {
636
      checkArgument(
1✔
637
          builder.idleTimeoutMillis
638
              >= ManagedChannelImplBuilder.IDLE_MODE_MIN_TIMEOUT_MILLIS,
639
          "invalid idleTimeoutMillis %s", builder.idleTimeoutMillis);
640
      this.idleTimeoutMillis = builder.idleTimeoutMillis;
1✔
641
    }
642

643
    idleTimer = new Rescheduler(
1✔
644
        new IdleModeTimer(),
645
        syncContext,
646
        transportFactory.getScheduledExecutorService(),
1✔
647
        stopwatchSupplier.get());
1✔
648
    this.fullStreamDecompression = builder.fullStreamDecompression;
1✔
649
    this.decompressorRegistry = checkNotNull(builder.decompressorRegistry, "decompressorRegistry");
1✔
650
    this.compressorRegistry = checkNotNull(builder.compressorRegistry, "compressorRegistry");
1✔
651
    this.userAgent = builder.userAgent;
1✔
652

653
    this.channelBufferLimit = builder.retryBufferSize;
1✔
654
    this.perRpcBufferLimit = builder.perRpcBufferLimit;
1✔
655
    final class ChannelCallTracerFactory implements CallTracer.Factory {
1✔
656
      @Override
657
      public CallTracer create() {
658
        return new CallTracer(timeProvider);
1✔
659
      }
660
    }
661

662
    this.callTracerFactory = new ChannelCallTracerFactory();
1✔
663
    channelCallTracer = callTracerFactory.create();
1✔
664
    this.channelz = checkNotNull(builder.channelz);
1✔
665
    channelz.addRootChannel(this);
1✔
666

667
    if (!lookUpServiceConfig) {
1✔
668
      if (defaultServiceConfig != null) {
1✔
669
        channelLogger.log(
1✔
670
            ChannelLogLevel.INFO, "Service config look-up disabled, using default service config");
671
      }
672
      serviceConfigUpdated = true;
1✔
673
    }
674
    this.metricRecorder = new MetricRecorderImpl(builder.metricSinks,
1✔
675
        MetricInstrumentRegistry.getDefaultRegistry());
1✔
676
  }
1✔
677

678
  @VisibleForTesting
679
  static NameResolver getNameResolver(
680
      URI targetUri, @Nullable final String overrideAuthority,
681
      NameResolverProvider provider, NameResolver.Args nameResolverArgs) {
682
    NameResolver resolver = provider.newNameResolver(targetUri, nameResolverArgs);
1✔
683
    if (resolver == null) {
1✔
684
      throw new IllegalArgumentException("cannot create a NameResolver for " + targetUri);
1✔
685
    }
686

687
    // We wrap the name resolver in a RetryingNameResolver to give it the ability to retry failures.
688
    // TODO: After a transition period, all NameResolver implementations that need retry should use
689
    //       RetryingNameResolver directly and this step can be removed.
690
    NameResolver usedNameResolver = new RetryingNameResolver(resolver,
1✔
691
          new BackoffPolicyRetryScheduler(new ExponentialBackoffPolicy.Provider(),
692
              nameResolverArgs.getScheduledExecutorService(),
1✔
693
              nameResolverArgs.getSynchronizationContext()),
1✔
694
          nameResolverArgs.getSynchronizationContext());
1✔
695

696
    if (overrideAuthority == null) {
1✔
697
      return usedNameResolver;
1✔
698
    }
699

700
    return new ForwardingNameResolver(usedNameResolver) {
1✔
701
      @Override
702
      public String getServiceAuthority() {
703
        return overrideAuthority;
1✔
704
      }
705
    };
706
  }
707

708
  @VisibleForTesting
709
  InternalConfigSelector getConfigSelector() {
710
    return realChannel.configSelector.get();
1✔
711
  }
712
  
713
  @VisibleForTesting
714
  boolean hasThrottle() {
715
    return this.transportProvider.throttle != null;
1✔
716
  }
717

718
  /**
719
   * Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately
720
   * cancelled.
721
   */
722
  @Override
723
  public ManagedChannelImpl shutdown() {
724
    channelLogger.log(ChannelLogLevel.DEBUG, "shutdown() called");
1✔
725
    if (!shutdown.compareAndSet(false, true)) {
1✔
726
      return this;
1✔
727
    }
728
    final class Shutdown implements Runnable {
1✔
729
      @Override
730
      public void run() {
731
        channelLogger.log(ChannelLogLevel.INFO, "Entering SHUTDOWN state");
1✔
732
        channelStateManager.gotoState(SHUTDOWN);
1✔
733
      }
1✔
734
    }
735

736
    syncContext.execute(new Shutdown());
1✔
737
    realChannel.shutdown();
1✔
738
    final class CancelIdleTimer implements Runnable {
1✔
739
      @Override
740
      public void run() {
741
        cancelIdleTimer(/* permanent= */ true);
1✔
742
      }
1✔
743
    }
744

745
    syncContext.execute(new CancelIdleTimer());
1✔
746
    return this;
1✔
747
  }
748

749
  /**
750
   * Initiates a forceful shutdown in which preexisting and new calls are cancelled. Although
751
   * forceful, the shutdown process is still not instantaneous; {@link #isTerminated()} will likely
752
   * return {@code false} immediately after this method returns.
753
   */
754
  @Override
755
  public ManagedChannelImpl shutdownNow() {
756
    channelLogger.log(ChannelLogLevel.DEBUG, "shutdownNow() called");
1✔
757
    shutdown();
1✔
758
    realChannel.shutdownNow();
1✔
759
    final class ShutdownNow implements Runnable {
1✔
760
      @Override
761
      public void run() {
762
        if (shutdownNowed) {
1✔
763
          return;
1✔
764
        }
765
        shutdownNowed = true;
1✔
766
        maybeShutdownNowSubchannels();
1✔
767
      }
1✔
768
    }
769

770
    syncContext.execute(new ShutdownNow());
1✔
771
    return this;
1✔
772
  }
773

774
  // Called from syncContext
775
  @VisibleForTesting
776
  void panic(final Throwable t) {
777
    if (panicMode) {
1✔
778
      // Preserve the first panic information
779
      return;
×
780
    }
781
    panicMode = true;
1✔
782
    try {
783
      cancelIdleTimer(/* permanent= */ true);
1✔
784
      shutdownNameResolverAndLoadBalancer(false);
1✔
785
    } finally {
786
      updateSubchannelPicker(new LoadBalancer.FixedResultPicker(PickResult.withDrop(
1✔
787
          Status.INTERNAL.withDescription("Panic! This is a bug!").withCause(t))));
1✔
788
      realChannel.updateConfigSelector(null);
1✔
789
      channelLogger.log(ChannelLogLevel.ERROR, "PANIC! Entering TRANSIENT_FAILURE");
1✔
790
      channelStateManager.gotoState(TRANSIENT_FAILURE);
1✔
791
    }
792
  }
1✔
793

794
  @VisibleForTesting
795
  boolean isInPanicMode() {
796
    return panicMode;
1✔
797
  }
798

799
  // Called from syncContext
800
  private void updateSubchannelPicker(SubchannelPicker newPicker) {
801
    subchannelPicker = newPicker;
1✔
802
    delayedTransport.reprocess(newPicker);
1✔
803
  }
1✔
804

805
  @Override
806
  public boolean isShutdown() {
807
    return shutdown.get();
1✔
808
  }
809

810
  @Override
811
  public boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException {
812
    return terminatedLatch.await(timeout, unit);
1✔
813
  }
814

815
  @Override
816
  public boolean isTerminated() {
817
    return terminated;
1✔
818
  }
819

820
  /*
821
   * Creates a new outgoing call on the channel.
822
   */
823
  @Override
824
  public <ReqT, RespT> ClientCall<ReqT, RespT> newCall(MethodDescriptor<ReqT, RespT> method,
825
      CallOptions callOptions) {
826
    return interceptorChannel.newCall(method, callOptions);
1✔
827
  }
828

829
  @Override
830
  public String authority() {
831
    return interceptorChannel.authority();
1✔
832
  }
833

834
  private Executor getCallExecutor(CallOptions callOptions) {
835
    Executor executor = callOptions.getExecutor();
1✔
836
    if (executor == null) {
1✔
837
      executor = this.executor;
1✔
838
    }
839
    return executor;
1✔
840
  }
841

842
  private class RealChannel extends Channel {
843
    // Reference to null if no config selector is available from resolution result
844
    // Reference must be set() from syncContext
845
    private final AtomicReference<InternalConfigSelector> configSelector =
1✔
846
        new AtomicReference<>(INITIAL_PENDING_SELECTOR);
1✔
847
    // Set when the NameResolver is initially created. When we create a new NameResolver for the
848
    // same target, the new instance must have the same value.
849
    private final String authority;
850

851
    private final Channel clientCallImplChannel = new Channel() {
1✔
852
      @Override
853
      public <RequestT, ResponseT> ClientCall<RequestT, ResponseT> newCall(
854
          MethodDescriptor<RequestT, ResponseT> method, CallOptions callOptions) {
855
        return new ClientCallImpl<>(
1✔
856
            method,
857
            getCallExecutor(callOptions),
1✔
858
            callOptions,
859
            transportProvider,
1✔
860
            terminated ? null : transportFactory.getScheduledExecutorService(),
1✔
861
            channelCallTracer,
1✔
862
            null)
863
            .setFullStreamDecompression(fullStreamDecompression)
1✔
864
            .setDecompressorRegistry(decompressorRegistry)
1✔
865
            .setCompressorRegistry(compressorRegistry);
1✔
866
      }
867

868
      @Override
869
      public String authority() {
870
        return authority;
×
871
      }
872
    };
873

874
    private RealChannel(String authority) {
1✔
875
      this.authority =  checkNotNull(authority, "authority");
1✔
876
    }
1✔
877

878
    @Override
879
    public <ReqT, RespT> ClientCall<ReqT, RespT> newCall(
880
        MethodDescriptor<ReqT, RespT> method, CallOptions callOptions) {
881
      if (configSelector.get() != INITIAL_PENDING_SELECTOR) {
1✔
882
        return newClientCall(method, callOptions);
1✔
883
      }
884
      syncContext.execute(new Runnable() {
1✔
885
        @Override
886
        public void run() {
887
          exitIdleMode();
1✔
888
        }
1✔
889
      });
890
      if (configSelector.get() != INITIAL_PENDING_SELECTOR) {
1✔
891
        // This is an optimization for the case (typically with InProcessTransport) when name
892
        // resolution result is immediately available at this point. Otherwise, some users'
893
        // tests might observe slight behavior difference from earlier grpc versions.
894
        return newClientCall(method, callOptions);
1✔
895
      }
896
      if (shutdown.get()) {
1✔
897
        // Return a failing ClientCall.
898
        return new ClientCall<ReqT, RespT>() {
×
899
          @Override
900
          public void start(Listener<RespT> responseListener, Metadata headers) {
901
            responseListener.onClose(SHUTDOWN_STATUS, new Metadata());
×
902
          }
×
903

904
          @Override public void request(int numMessages) {}
×
905

906
          @Override public void cancel(@Nullable String message, @Nullable Throwable cause) {}
×
907

908
          @Override public void halfClose() {}
×
909

910
          @Override public void sendMessage(ReqT message) {}
×
911
        };
912
      }
913
      Context context = Context.current();
1✔
914
      final PendingCall<ReqT, RespT> pendingCall = new PendingCall<>(context, method, callOptions);
1✔
915
      syncContext.execute(new Runnable() {
1✔
916
        @Override
917
        public void run() {
918
          if (configSelector.get() == INITIAL_PENDING_SELECTOR) {
1✔
919
            if (pendingCalls == null) {
1✔
920
              pendingCalls = new LinkedHashSet<>();
1✔
921
              inUseStateAggregator.updateObjectInUse(pendingCallsInUseObject, true);
1✔
922
            }
923
            pendingCalls.add(pendingCall);
1✔
924
          } else {
925
            pendingCall.reprocess();
1✔
926
          }
927
        }
1✔
928
      });
929
      return pendingCall;
1✔
930
    }
931

932
    // Must run in SynchronizationContext.
933
    void updateConfigSelector(@Nullable InternalConfigSelector config) {
934
      InternalConfigSelector prevConfig = configSelector.get();
1✔
935
      configSelector.set(config);
1✔
936
      if (prevConfig == INITIAL_PENDING_SELECTOR && pendingCalls != null) {
1✔
937
        for (RealChannel.PendingCall<?, ?> pendingCall : pendingCalls) {
1✔
938
          pendingCall.reprocess();
1✔
939
        }
1✔
940
      }
941
    }
1✔
942

943
    // Must run in SynchronizationContext.
944
    void onConfigError() {
945
      if (configSelector.get() == INITIAL_PENDING_SELECTOR) {
1✔
946
        // Apply Default Service Config if initial name resolution fails.
947
        if (defaultServiceConfig != null) {
1✔
948
          updateConfigSelector(defaultServiceConfig.getDefaultConfigSelector());
1✔
949
          lastServiceConfig = defaultServiceConfig;
1✔
950
          channelLogger.log(ChannelLogLevel.ERROR,
1✔
951
              "Initial Name Resolution error, using default service config");
952
        } else {
953
          updateConfigSelector(null);
1✔
954
        }
955
      }
956
    }
1✔
957

958
    void shutdown() {
959
      final class RealChannelShutdown implements Runnable {
1✔
960
        @Override
961
        public void run() {
962
          if (pendingCalls == null) {
1✔
963
            if (configSelector.get() == INITIAL_PENDING_SELECTOR) {
1✔
964
              configSelector.set(null);
1✔
965
            }
966
            uncommittedRetriableStreamsRegistry.onShutdown(SHUTDOWN_STATUS);
1✔
967
          }
968
        }
1✔
969
      }
970

971
      syncContext.execute(new RealChannelShutdown());
1✔
972
    }
1✔
973

974
    void shutdownNow() {
975
      final class RealChannelShutdownNow implements Runnable {
1✔
976
        @Override
977
        public void run() {
978
          if (configSelector.get() == INITIAL_PENDING_SELECTOR) {
1✔
979
            configSelector.set(null);
1✔
980
          }
981
          if (pendingCalls != null) {
1✔
982
            for (RealChannel.PendingCall<?, ?> pendingCall : pendingCalls) {
1✔
983
              pendingCall.cancel("Channel is forcefully shutdown", null);
1✔
984
            }
1✔
985
          }
986
          uncommittedRetriableStreamsRegistry.onShutdownNow(SHUTDOWN_NOW_STATUS);
1✔
987
        }
1✔
988
      }
989

990
      syncContext.execute(new RealChannelShutdownNow());
1✔
991
    }
1✔
992

993
    @Override
994
    public String authority() {
995
      return authority;
1✔
996
    }
997

998
    private final class PendingCall<ReqT, RespT> extends DelayedClientCall<ReqT, RespT> {
999
      final Context context;
1000
      final MethodDescriptor<ReqT, RespT> method;
1001
      final CallOptions callOptions;
1002
      private final long callCreationTime;
1003

1004
      PendingCall(
1005
          Context context, MethodDescriptor<ReqT, RespT> method, CallOptions callOptions) {
1✔
1006
        super(getCallExecutor(callOptions), scheduledExecutor, callOptions.getDeadline());
1✔
1007
        this.context = context;
1✔
1008
        this.method = method;
1✔
1009
        this.callOptions = callOptions;
1✔
1010
        this.callCreationTime = ticker.nanoTime();
1✔
1011
      }
1✔
1012

1013
      /** Called when it's ready to create a real call and reprocess the pending call. */
1014
      void reprocess() {
1015
        ClientCall<ReqT, RespT> realCall;
1016
        Context previous = context.attach();
1✔
1017
        try {
1018
          CallOptions delayResolutionOption = callOptions.withOption(NAME_RESOLUTION_DELAYED,
1✔
1019
              ticker.nanoTime() - callCreationTime);
1✔
1020
          realCall = newClientCall(method, delayResolutionOption);
1✔
1021
        } finally {
1022
          context.detach(previous);
1✔
1023
        }
1024
        Runnable toRun = setCall(realCall);
1✔
1025
        if (toRun == null) {
1✔
1026
          syncContext.execute(new PendingCallRemoval());
1✔
1027
        } else {
1028
          getCallExecutor(callOptions).execute(new Runnable() {
1✔
1029
            @Override
1030
            public void run() {
1031
              toRun.run();
1✔
1032
              syncContext.execute(new PendingCallRemoval());
1✔
1033
            }
1✔
1034
          });
1035
        }
1036
      }
1✔
1037

1038
      @Override
1039
      protected void callCancelled() {
1040
        super.callCancelled();
1✔
1041
        syncContext.execute(new PendingCallRemoval());
1✔
1042
      }
1✔
1043

1044
      final class PendingCallRemoval implements Runnable {
1✔
1045
        @Override
1046
        public void run() {
1047
          if (pendingCalls != null) {
1✔
1048
            pendingCalls.remove(PendingCall.this);
1✔
1049
            if (pendingCalls.isEmpty()) {
1✔
1050
              inUseStateAggregator.updateObjectInUse(pendingCallsInUseObject, false);
1✔
1051
              pendingCalls = null;
1✔
1052
              if (shutdown.get()) {
1✔
1053
                uncommittedRetriableStreamsRegistry.onShutdown(SHUTDOWN_STATUS);
1✔
1054
              }
1055
            }
1056
          }
1057
        }
1✔
1058
      }
1059
    }
1060

1061
    private <ReqT, RespT> ClientCall<ReqT, RespT> newClientCall(
1062
        MethodDescriptor<ReqT, RespT> method, CallOptions callOptions) {
1063
      InternalConfigSelector selector = configSelector.get();
1✔
1064
      if (selector == null) {
1✔
1065
        return clientCallImplChannel.newCall(method, callOptions);
1✔
1066
      }
1067
      if (selector instanceof ServiceConfigConvertedSelector) {
1✔
1068
        MethodInfo methodInfo =
1✔
1069
            ((ServiceConfigConvertedSelector) selector).config.getMethodConfig(method);
1✔
1070
        if (methodInfo != null) {
1✔
1071
          callOptions = callOptions.withOption(MethodInfo.KEY, methodInfo);
1✔
1072
        }
1073
        return clientCallImplChannel.newCall(method, callOptions);
1✔
1074
      }
1075
      return new ConfigSelectingClientCall<>(
1✔
1076
          selector, clientCallImplChannel, executor, method, callOptions);
1✔
1077
    }
1078
  }
1079

1080
  /**
1081
   * A client call for a given channel that applies a given config selector when it starts.
1082
   */
1083
  static final class ConfigSelectingClientCall<ReqT, RespT>
1084
      extends ForwardingClientCall<ReqT, RespT> {
1085

1086
    private final InternalConfigSelector configSelector;
1087
    private final Channel channel;
1088
    private final Executor callExecutor;
1089
    private final MethodDescriptor<ReqT, RespT> method;
1090
    private final Context context;
1091
    private CallOptions callOptions;
1092

1093
    private ClientCall<ReqT, RespT> delegate;
1094

1095
    ConfigSelectingClientCall(
1096
        InternalConfigSelector configSelector, Channel channel, Executor channelExecutor,
1097
        MethodDescriptor<ReqT, RespT> method,
1098
        CallOptions callOptions) {
1✔
1099
      this.configSelector = configSelector;
1✔
1100
      this.channel = channel;
1✔
1101
      this.method = method;
1✔
1102
      this.callExecutor =
1✔
1103
          callOptions.getExecutor() == null ? channelExecutor : callOptions.getExecutor();
1✔
1104
      this.callOptions = callOptions.withExecutor(callExecutor);
1✔
1105
      this.context = Context.current();
1✔
1106
    }
1✔
1107

1108
    @Override
1109
    protected ClientCall<ReqT, RespT> delegate() {
1110
      return delegate;
1✔
1111
    }
1112

1113
    @SuppressWarnings("unchecked")
1114
    @Override
1115
    public void start(Listener<RespT> observer, Metadata headers) {
1116
      PickSubchannelArgs args =
1✔
1117
          new PickSubchannelArgsImpl(method, headers, callOptions, NOOP_PICK_DETAILS_CONSUMER);
1✔
1118
      InternalConfigSelector.Result result = configSelector.selectConfig(args);
1✔
1119
      Status status = result.getStatus();
1✔
1120
      if (!status.isOk()) {
1✔
1121
        executeCloseObserverInContext(observer,
1✔
1122
            GrpcUtil.replaceInappropriateControlPlaneStatus(status));
1✔
1123
        delegate = (ClientCall<ReqT, RespT>) NOOP_CALL;
1✔
1124
        return;
1✔
1125
      }
1126
      ClientInterceptor interceptor = result.getInterceptor();
1✔
1127
      ManagedChannelServiceConfig config = (ManagedChannelServiceConfig) result.getConfig();
1✔
1128
      MethodInfo methodInfo = config.getMethodConfig(method);
1✔
1129
      if (methodInfo != null) {
1✔
1130
        callOptions = callOptions.withOption(MethodInfo.KEY, methodInfo);
1✔
1131
      }
1132
      if (interceptor != null) {
1✔
1133
        delegate = interceptor.interceptCall(method, callOptions, channel);
1✔
1134
      } else {
1135
        delegate = channel.newCall(method, callOptions);
×
1136
      }
1137
      delegate.start(observer, headers);
1✔
1138
    }
1✔
1139

1140
    private void executeCloseObserverInContext(
1141
        final Listener<RespT> observer, final Status status) {
1142
      class CloseInContext extends ContextRunnable {
1143
        CloseInContext() {
1✔
1144
          super(context);
1✔
1145
        }
1✔
1146

1147
        @Override
1148
        public void runInContext() {
1149
          observer.onClose(status, new Metadata());
1✔
1150
        }
1✔
1151
      }
1152

1153
      callExecutor.execute(new CloseInContext());
1✔
1154
    }
1✔
1155

1156
    @Override
1157
    public void cancel(@Nullable String message, @Nullable Throwable cause) {
1158
      if (delegate != null) {
×
1159
        delegate.cancel(message, cause);
×
1160
      }
1161
    }
×
1162
  }
1163

1164
  private static final ClientCall<Object, Object> NOOP_CALL = new ClientCall<Object, Object>() {
1✔
1165
    @Override
1166
    public void start(Listener<Object> responseListener, Metadata headers) {}
×
1167

1168
    @Override
1169
    public void request(int numMessages) {}
1✔
1170

1171
    @Override
1172
    public void cancel(String message, Throwable cause) {}
×
1173

1174
    @Override
1175
    public void halfClose() {}
×
1176

1177
    @Override
1178
    public void sendMessage(Object message) {}
×
1179

1180
    // Always returns {@code false}, since this is only used when the startup of the call fails.
1181
    @Override
1182
    public boolean isReady() {
1183
      return false;
×
1184
    }
1185
  };
1186

1187
  /**
1188
   * Terminate the channel if termination conditions are met.
1189
   */
1190
  // Must be run from syncContext
1191
  private void maybeTerminateChannel() {
1192
    if (terminated) {
1✔
1193
      return;
×
1194
    }
1195
    if (shutdown.get() && subchannels.isEmpty() && oobChannels.isEmpty()) {
1✔
1196
      channelLogger.log(ChannelLogLevel.INFO, "Terminated");
1✔
1197
      channelz.removeRootChannel(this);
1✔
1198
      executorPool.returnObject(executor);
1✔
1199
      balancerRpcExecutorHolder.release();
1✔
1200
      offloadExecutorHolder.release();
1✔
1201
      // Release the transport factory so that it can deallocate any resources.
1202
      transportFactory.close();
1✔
1203

1204
      terminated = true;
1✔
1205
      terminatedLatch.countDown();
1✔
1206
    }
1207
  }
1✔
1208

1209
  // Must be called from syncContext
1210
  private void handleInternalSubchannelState(ConnectivityStateInfo newState) {
1211
    if (newState.getState() == TRANSIENT_FAILURE || newState.getState() == IDLE) {
1✔
1212
      refreshNameResolution();
1✔
1213
    }
1214
  }
1✔
1215

1216
  @Override
1217
  @SuppressWarnings("deprecation")
1218
  public ConnectivityState getState(boolean requestConnection) {
1219
    ConnectivityState savedChannelState = channelStateManager.getState();
1✔
1220
    if (requestConnection && savedChannelState == IDLE) {
1✔
1221
      final class RequestConnection implements Runnable {
1✔
1222
        @Override
1223
        public void run() {
1224
          exitIdleMode();
1✔
1225
          if (subchannelPicker != null) {
1✔
1226
            subchannelPicker.requestConnection();
1✔
1227
          }
1228
          if (lbHelper != null) {
1✔
1229
            lbHelper.lb.requestConnection();
1✔
1230
          }
1231
        }
1✔
1232
      }
1233

1234
      syncContext.execute(new RequestConnection());
1✔
1235
    }
1236
    return savedChannelState;
1✔
1237
  }
1238

1239
  @Override
1240
  public void notifyWhenStateChanged(final ConnectivityState source, final Runnable callback) {
1241
    final class NotifyStateChanged implements Runnable {
1✔
1242
      @Override
1243
      public void run() {
1244
        channelStateManager.notifyWhenStateChanged(callback, executor, source);
1✔
1245
      }
1✔
1246
    }
1247

1248
    syncContext.execute(new NotifyStateChanged());
1✔
1249
  }
1✔
1250

1251
  @Override
1252
  public void resetConnectBackoff() {
1253
    final class ResetConnectBackoff implements Runnable {
1✔
1254
      @Override
1255
      public void run() {
1256
        if (shutdown.get()) {
1✔
1257
          return;
1✔
1258
        }
1259
        if (nameResolverStarted) {
1✔
1260
          refreshNameResolution();
1✔
1261
        }
1262
        for (InternalSubchannel subchannel : subchannels) {
1✔
1263
          subchannel.resetConnectBackoff();
1✔
1264
        }
1✔
1265
        for (OobChannel oobChannel : oobChannels) {
1✔
1266
          oobChannel.resetConnectBackoff();
×
1267
        }
×
1268
      }
1✔
1269
    }
1270

1271
    syncContext.execute(new ResetConnectBackoff());
1✔
1272
  }
1✔
1273

1274
  @Override
1275
  public void enterIdle() {
1276
    final class PrepareToLoseNetworkRunnable implements Runnable {
1✔
1277
      @Override
1278
      public void run() {
1279
        if (shutdown.get() || lbHelper == null) {
1✔
1280
          return;
1✔
1281
        }
1282
        cancelIdleTimer(/* permanent= */ false);
1✔
1283
        enterIdleMode();
1✔
1284
      }
1✔
1285
    }
1286

1287
    syncContext.execute(new PrepareToLoseNetworkRunnable());
1✔
1288
  }
1✔
1289

1290
  /**
1291
   * A registry that prevents channel shutdown from killing existing retry attempts that are in
1292
   * backoff.
1293
   */
1294
  private final class UncommittedRetriableStreamsRegistry {
1✔
1295
    // TODO(zdapeng): This means we would acquire a lock for each new retry-able stream,
1296
    // it's worthwhile to look for a lock-free approach.
1297
    final Object lock = new Object();
1✔
1298

1299
    @GuardedBy("lock")
1✔
1300
    Collection<ClientStream> uncommittedRetriableStreams = new HashSet<>();
1301

1302
    @GuardedBy("lock")
1303
    Status shutdownStatus;
1304

1305
    void onShutdown(Status reason) {
1306
      boolean shouldShutdownDelayedTransport = false;
1✔
1307
      synchronized (lock) {
1✔
1308
        if (shutdownStatus != null) {
1✔
1309
          return;
1✔
1310
        }
1311
        shutdownStatus = reason;
1✔
1312
        // Keep the delayedTransport open until there is no more uncommitted streams, b/c those
1313
        // retriable streams, which may be in backoff and not using any transport, are already
1314
        // started RPCs.
1315
        if (uncommittedRetriableStreams.isEmpty()) {
1✔
1316
          shouldShutdownDelayedTransport = true;
1✔
1317
        }
1318
      }
1✔
1319

1320
      if (shouldShutdownDelayedTransport) {
1✔
1321
        delayedTransport.shutdown(reason);
1✔
1322
      }
1323
    }
1✔
1324

1325
    void onShutdownNow(Status reason) {
1326
      onShutdown(reason);
1✔
1327
      Collection<ClientStream> streams;
1328

1329
      synchronized (lock) {
1✔
1330
        streams = new ArrayList<>(uncommittedRetriableStreams);
1✔
1331
      }
1✔
1332

1333
      for (ClientStream stream : streams) {
1✔
1334
        stream.cancel(reason);
1✔
1335
      }
1✔
1336
      delayedTransport.shutdownNow(reason);
1✔
1337
    }
1✔
1338

1339
    /**
1340
     * Registers a RetriableStream and return null if not shutdown, otherwise just returns the
1341
     * shutdown Status.
1342
     */
1343
    @Nullable
1344
    Status add(RetriableStream<?> retriableStream) {
1345
      synchronized (lock) {
1✔
1346
        if (shutdownStatus != null) {
1✔
1347
          return shutdownStatus;
1✔
1348
        }
1349
        uncommittedRetriableStreams.add(retriableStream);
1✔
1350
        return null;
1✔
1351
      }
1352
    }
1353

1354
    void remove(RetriableStream<?> retriableStream) {
1355
      Status shutdownStatusCopy = null;
1✔
1356

1357
      synchronized (lock) {
1✔
1358
        uncommittedRetriableStreams.remove(retriableStream);
1✔
1359
        if (uncommittedRetriableStreams.isEmpty()) {
1✔
1360
          shutdownStatusCopy = shutdownStatus;
1✔
1361
          // Because retriable transport is long-lived, we take this opportunity to down-size the
1362
          // hashmap.
1363
          uncommittedRetriableStreams = new HashSet<>();
1✔
1364
        }
1365
      }
1✔
1366

1367
      if (shutdownStatusCopy != null) {
1✔
1368
        delayedTransport.shutdown(shutdownStatusCopy);
1✔
1369
      }
1370
    }
1✔
1371
  }
1372

1373
  private final class LbHelperImpl extends LoadBalancer.Helper {
1✔
1374
    AutoConfiguredLoadBalancer lb;
1375

1376
    @Override
1377
    public AbstractSubchannel createSubchannel(CreateSubchannelArgs args) {
1378
      syncContext.throwIfNotInThisSynchronizationContext();
1✔
1379
      // No new subchannel should be created after load balancer has been shutdown.
1380
      checkState(!terminating, "Channel is being terminated");
1✔
1381
      return new SubchannelImpl(args);
1✔
1382
    }
1383

1384
    @Override
1385
    public void updateBalancingState(
1386
        final ConnectivityState newState, final SubchannelPicker newPicker) {
1387
      syncContext.throwIfNotInThisSynchronizationContext();
1✔
1388
      checkNotNull(newState, "newState");
1✔
1389
      checkNotNull(newPicker, "newPicker");
1✔
1390
      final class UpdateBalancingState implements Runnable {
1✔
1391
        @Override
1392
        public void run() {
1393
          if (LbHelperImpl.this != lbHelper || panicMode) {
1✔
1394
            return;
1✔
1395
          }
1396
          updateSubchannelPicker(newPicker);
1✔
1397
          // It's not appropriate to report SHUTDOWN state from lb.
1398
          // Ignore the case of newState == SHUTDOWN for now.
1399
          if (newState != SHUTDOWN) {
1✔
1400
            channelLogger.log(
1✔
1401
                ChannelLogLevel.INFO, "Entering {0} state with picker: {1}", newState, newPicker);
1402
            channelStateManager.gotoState(newState);
1✔
1403
          }
1404
        }
1✔
1405
      }
1406

1407
      syncContext.execute(new UpdateBalancingState());
1✔
1408
    }
1✔
1409

1410
    @Override
1411
    public void refreshNameResolution() {
1412
      syncContext.throwIfNotInThisSynchronizationContext();
1✔
1413
      final class LoadBalancerRefreshNameResolution implements Runnable {
1✔
1414
        @Override
1415
        public void run() {
1416
          ManagedChannelImpl.this.refreshNameResolution();
1✔
1417
        }
1✔
1418
      }
1419

1420
      syncContext.execute(new LoadBalancerRefreshNameResolution());
1✔
1421
    }
1✔
1422

1423
    @Override
1424
    public ManagedChannel createOobChannel(EquivalentAddressGroup addressGroup, String authority) {
1425
      return createOobChannel(Collections.singletonList(addressGroup), authority);
×
1426
    }
1427

1428
    @Override
1429
    public ManagedChannel createOobChannel(List<EquivalentAddressGroup> addressGroup,
1430
        String authority) {
1431
      // TODO(ejona): can we be even stricter? Like terminating?
1432
      checkState(!terminated, "Channel is terminated");
1✔
1433
      long oobChannelCreationTime = timeProvider.currentTimeNanos();
1✔
1434
      InternalLogId oobLogId = InternalLogId.allocate("OobChannel", /*details=*/ null);
1✔
1435
      InternalLogId subchannelLogId =
1✔
1436
          InternalLogId.allocate("Subchannel-OOB", /*details=*/ authority);
1✔
1437
      ChannelTracer oobChannelTracer =
1✔
1438
          new ChannelTracer(
1439
              oobLogId, maxTraceEvents, oobChannelCreationTime,
1✔
1440
              "OobChannel for " + addressGroup);
1441
      final OobChannel oobChannel = new OobChannel(
1✔
1442
          authority, balancerRpcExecutorPool, oobTransportFactory.getScheduledExecutorService(),
1✔
1443
          syncContext, callTracerFactory.create(), oobChannelTracer, channelz, timeProvider);
1✔
1444
      channelTracer.reportEvent(new ChannelTrace.Event.Builder()
1✔
1445
          .setDescription("Child OobChannel created")
1✔
1446
          .setSeverity(ChannelTrace.Event.Severity.CT_INFO)
1✔
1447
          .setTimestampNanos(oobChannelCreationTime)
1✔
1448
          .setChannelRef(oobChannel)
1✔
1449
          .build());
1✔
1450
      ChannelTracer subchannelTracer =
1✔
1451
          new ChannelTracer(subchannelLogId, maxTraceEvents, oobChannelCreationTime,
1✔
1452
              "Subchannel for " + addressGroup);
1453
      ChannelLogger subchannelLogger = new ChannelLoggerImpl(subchannelTracer, timeProvider);
1✔
1454
      final class ManagedOobChannelCallback extends InternalSubchannel.Callback {
1✔
1455
        @Override
1456
        void onTerminated(InternalSubchannel is) {
1457
          oobChannels.remove(oobChannel);
1✔
1458
          channelz.removeSubchannel(is);
1✔
1459
          oobChannel.handleSubchannelTerminated();
1✔
1460
          maybeTerminateChannel();
1✔
1461
        }
1✔
1462

1463
        @Override
1464
        void onStateChange(InternalSubchannel is, ConnectivityStateInfo newState) {
1465
          // TODO(chengyuanzhang): change to let LB policies explicitly manage OOB channel's
1466
          //  state and refresh name resolution if necessary.
1467
          handleInternalSubchannelState(newState);
1✔
1468
          oobChannel.handleSubchannelStateChange(newState);
1✔
1469
        }
1✔
1470
      }
1471

1472
      final InternalSubchannel internalSubchannel = new InternalSubchannel(
1✔
1473
          CreateSubchannelArgs.newBuilder().setAddresses(addressGroup).build(),
1✔
1474
          authority, userAgent, backoffPolicyProvider, oobTransportFactory,
1✔
1475
          oobTransportFactory.getScheduledExecutorService(), stopwatchSupplier, syncContext,
1✔
1476
          // All callback methods are run from syncContext
1477
          new ManagedOobChannelCallback(),
1478
          channelz,
1✔
1479
          callTracerFactory.create(),
1✔
1480
          subchannelTracer,
1481
          subchannelLogId,
1482
          subchannelLogger,
1483
          transportFilters);
1✔
1484
      oobChannelTracer.reportEvent(new ChannelTrace.Event.Builder()
1✔
1485
          .setDescription("Child Subchannel created")
1✔
1486
          .setSeverity(ChannelTrace.Event.Severity.CT_INFO)
1✔
1487
          .setTimestampNanos(oobChannelCreationTime)
1✔
1488
          .setSubchannelRef(internalSubchannel)
1✔
1489
          .build());
1✔
1490
      channelz.addSubchannel(oobChannel);
1✔
1491
      channelz.addSubchannel(internalSubchannel);
1✔
1492
      oobChannel.setSubchannel(internalSubchannel);
1✔
1493
      final class AddOobChannel implements Runnable {
1✔
1494
        @Override
1495
        public void run() {
1496
          if (terminating) {
1✔
1497
            oobChannel.shutdown();
×
1498
          }
1499
          if (!terminated) {
1✔
1500
            // If channel has not terminated, it will track the subchannel and block termination
1501
            // for it.
1502
            oobChannels.add(oobChannel);
1✔
1503
          }
1504
        }
1✔
1505
      }
1506

1507
      syncContext.execute(new AddOobChannel());
1✔
1508
      return oobChannel;
1✔
1509
    }
1510

1511
    @Deprecated
1512
    @Override
1513
    public ManagedChannelBuilder<?> createResolvingOobChannelBuilder(String target) {
1514
      return createResolvingOobChannelBuilder(target, new DefaultChannelCreds())
1✔
1515
          // Override authority to keep the old behavior.
1516
          // createResolvingOobChannelBuilder(String target) will be deleted soon.
1517
          .overrideAuthority(getAuthority());
1✔
1518
    }
1519

1520
    // TODO(creamsoup) prevent main channel to shutdown if oob channel is not terminated
1521
    // TODO(zdapeng) register the channel as a subchannel of the parent channel in channelz.
1522
    @Override
1523
    public ManagedChannelBuilder<?> createResolvingOobChannelBuilder(
1524
        final String target, final ChannelCredentials channelCreds) {
1525
      checkNotNull(channelCreds, "channelCreds");
1✔
1526

1527
      final class ResolvingOobChannelBuilder
1528
          extends ForwardingChannelBuilder2<ResolvingOobChannelBuilder> {
1529
        final ManagedChannelBuilder<?> delegate;
1530

1531
        ResolvingOobChannelBuilder() {
1✔
1532
          final ClientTransportFactory transportFactory;
1533
          CallCredentials callCredentials;
1534
          if (channelCreds instanceof DefaultChannelCreds) {
1✔
1535
            transportFactory = originalTransportFactory;
1✔
1536
            callCredentials = null;
1✔
1537
          } else {
1538
            SwapChannelCredentialsResult swapResult =
1✔
1539
                originalTransportFactory.swapChannelCredentials(channelCreds);
1✔
1540
            if (swapResult == null) {
1✔
1541
              delegate = Grpc.newChannelBuilder(target, channelCreds);
×
1542
              return;
×
1543
            } else {
1544
              transportFactory = swapResult.transportFactory;
1✔
1545
              callCredentials = swapResult.callCredentials;
1✔
1546
            }
1547
          }
1548
          ClientTransportFactoryBuilder transportFactoryBuilder =
1✔
1549
              new ClientTransportFactoryBuilder() {
1✔
1550
                @Override
1551
                public ClientTransportFactory buildClientTransportFactory() {
1552
                  return transportFactory;
1✔
1553
                }
1554
              };
1555
          delegate = new ManagedChannelImplBuilder(
1✔
1556
              target,
1557
              channelCreds,
1558
              callCredentials,
1559
              transportFactoryBuilder,
1560
              new FixedPortProvider(nameResolverArgs.getDefaultPort()))
1✔
1561
              .nameResolverRegistry(nameResolverRegistry);
1✔
1562
        }
1✔
1563

1564
        @Override
1565
        protected ManagedChannelBuilder<?> delegate() {
1566
          return delegate;
1✔
1567
        }
1568
      }
1569

1570
      checkState(!terminated, "Channel is terminated");
1✔
1571

1572
      @SuppressWarnings("deprecation")
1573
      ResolvingOobChannelBuilder builder = new ResolvingOobChannelBuilder();
1✔
1574

1575
      return builder
1✔
1576
          // TODO(zdapeng): executors should not outlive the parent channel.
1577
          .executor(executor)
1✔
1578
          .offloadExecutor(offloadExecutorHolder.getExecutor())
1✔
1579
          .maxTraceEvents(maxTraceEvents)
1✔
1580
          .proxyDetector(nameResolverArgs.getProxyDetector())
1✔
1581
          .userAgent(userAgent);
1✔
1582
    }
1583

1584
    @Override
1585
    public ChannelCredentials getUnsafeChannelCredentials() {
1586
      if (originalChannelCreds == null) {
1✔
1587
        return new DefaultChannelCreds();
1✔
1588
      }
1589
      return originalChannelCreds;
×
1590
    }
1591

1592
    @Override
1593
    public void updateOobChannelAddresses(ManagedChannel channel, EquivalentAddressGroup eag) {
1594
      updateOobChannelAddresses(channel, Collections.singletonList(eag));
×
1595
    }
×
1596

1597
    @Override
1598
    public void updateOobChannelAddresses(ManagedChannel channel,
1599
        List<EquivalentAddressGroup> eag) {
1600
      checkArgument(channel instanceof OobChannel,
1✔
1601
          "channel must have been returned from createOobChannel");
1602
      ((OobChannel) channel).updateAddresses(eag);
1✔
1603
    }
1✔
1604

1605
    @Override
1606
    public String getAuthority() {
1607
      return ManagedChannelImpl.this.authority();
1✔
1608
    }
1609

1610
    @Override
1611
    public String getChannelTarget() {
1612
      return targetUri.toString();
1✔
1613
    }
1614

1615
    @Override
1616
    public SynchronizationContext getSynchronizationContext() {
1617
      return syncContext;
1✔
1618
    }
1619

1620
    @Override
1621
    public ScheduledExecutorService getScheduledExecutorService() {
1622
      return scheduledExecutor;
1✔
1623
    }
1624

1625
    @Override
1626
    public ChannelLogger getChannelLogger() {
1627
      return channelLogger;
1✔
1628
    }
1629

1630
    @Override
1631
    public NameResolver.Args getNameResolverArgs() {
1632
      return nameResolverArgs;
1✔
1633
    }
1634

1635
    @Override
1636
    public NameResolverRegistry getNameResolverRegistry() {
1637
      return nameResolverRegistry;
1✔
1638
    }
1639

1640
    @Override
1641
    public MetricRecorder getMetricRecorder() {
1642
      return metricRecorder;
1✔
1643
    }
1644

1645
    /**
1646
     * A placeholder for channel creds if user did not specify channel creds for the channel.
1647
     */
1648
    // TODO(zdapeng): get rid of this class and let all ChannelBuilders always provide a non-null
1649
    //     channel creds.
1650
    final class DefaultChannelCreds extends ChannelCredentials {
1✔
1651
      @Override
1652
      public ChannelCredentials withoutBearerTokens() {
1653
        return this;
×
1654
      }
1655
    }
1656
  }
1657

1658
  final class NameResolverListener extends NameResolver.Listener2 {
1659
    final LbHelperImpl helper;
1660
    final NameResolver resolver;
1661

1662
    NameResolverListener(LbHelperImpl helperImpl, NameResolver resolver) {
1✔
1663
      this.helper = checkNotNull(helperImpl, "helperImpl");
1✔
1664
      this.resolver = checkNotNull(resolver, "resolver");
1✔
1665
    }
1✔
1666

1667
    @Override
1668
    public void onResult(final ResolutionResult resolutionResult) {
1669
      final class NamesResolved implements Runnable {
1✔
1670

1671
        @Override
1672
        public void run() {
1673
          Status status = onResult2(resolutionResult);
1✔
1674
          ResolutionResultListener resolutionResultListener = resolutionResult.getAttributes()
1✔
1675
              .get(RetryingNameResolver.RESOLUTION_RESULT_LISTENER_KEY);
1✔
1676
          resolutionResultListener.resolutionAttempted(status);
1✔
1677
        }
1✔
1678
      }
1679

1680
      syncContext.execute(new NamesResolved());
1✔
1681
    }
1✔
1682

1683
    @SuppressWarnings("ReferenceEquality")
1684
    @Override
1685
    public Status onResult2(final ResolutionResult resolutionResult) {
1686
      syncContext.throwIfNotInThisSynchronizationContext();
1✔
1687
      if (ManagedChannelImpl.this.nameResolver != resolver) {
1✔
1688
        return Status.OK;
1✔
1689
      }
1690

1691
      StatusOr<List<EquivalentAddressGroup>> serversOrError =
1✔
1692
          resolutionResult.getAddressesOrError();
1✔
1693
      if (!serversOrError.hasValue()) {
1✔
1694
        handleErrorInSyncContext(serversOrError.getStatus());
1✔
1695
        return serversOrError.getStatus();
1✔
1696
      }
1697
      List<EquivalentAddressGroup> servers = serversOrError.getValue();
1✔
1698
      channelLogger.log(
1✔
1699
          ChannelLogLevel.DEBUG,
1700
          "Resolved address: {0}, config={1}",
1701
          servers,
1702
          resolutionResult.getAttributes());
1✔
1703

1704
      if (lastResolutionState != ResolutionState.SUCCESS) {
1✔
1705
        channelLogger.log(ChannelLogLevel.INFO, "Address resolved: {0}",
1✔
1706
            servers);
1707
        lastResolutionState = ResolutionState.SUCCESS;
1✔
1708
      }
1709
      ConfigOrError configOrError = resolutionResult.getServiceConfig();
1✔
1710
      InternalConfigSelector resolvedConfigSelector =
1✔
1711
          resolutionResult.getAttributes().get(InternalConfigSelector.KEY);
1✔
1712
      ManagedChannelServiceConfig validServiceConfig =
1713
          configOrError != null && configOrError.getConfig() != null
1✔
1714
              ? (ManagedChannelServiceConfig) configOrError.getConfig()
1✔
1715
              : null;
1✔
1716
      Status serviceConfigError = configOrError != null ? configOrError.getError() : null;
1✔
1717

1718
      ManagedChannelServiceConfig effectiveServiceConfig;
1719
      if (!lookUpServiceConfig) {
1✔
1720
        if (validServiceConfig != null) {
1✔
1721
          channelLogger.log(
1✔
1722
              ChannelLogLevel.INFO,
1723
              "Service config from name resolver discarded by channel settings");
1724
        }
1725
        effectiveServiceConfig =
1726
            defaultServiceConfig == null ? EMPTY_SERVICE_CONFIG : defaultServiceConfig;
1✔
1727
        if (resolvedConfigSelector != null) {
1✔
1728
          channelLogger.log(
1✔
1729
              ChannelLogLevel.INFO,
1730
              "Config selector from name resolver discarded by channel settings");
1731
        }
1732
        realChannel.updateConfigSelector(effectiveServiceConfig.getDefaultConfigSelector());
1✔
1733
      } else {
1734
        // Try to use config if returned from name resolver
1735
        // Otherwise, try to use the default config if available
1736
        if (validServiceConfig != null) {
1✔
1737
          effectiveServiceConfig = validServiceConfig;
1✔
1738
          if (resolvedConfigSelector != null) {
1✔
1739
            realChannel.updateConfigSelector(resolvedConfigSelector);
1✔
1740
            if (effectiveServiceConfig.getDefaultConfigSelector() != null) {
1✔
1741
              channelLogger.log(
×
1742
                  ChannelLogLevel.DEBUG,
1743
                  "Method configs in service config will be discarded due to presence of"
1744
                      + "config-selector");
1745
            }
1746
          } else {
1747
            realChannel.updateConfigSelector(effectiveServiceConfig.getDefaultConfigSelector());
1✔
1748
          }
1749
        } else if (defaultServiceConfig != null) {
1✔
1750
          effectiveServiceConfig = defaultServiceConfig;
1✔
1751
          realChannel.updateConfigSelector(effectiveServiceConfig.getDefaultConfigSelector());
1✔
1752
          channelLogger.log(
1✔
1753
              ChannelLogLevel.INFO,
1754
              "Received no service config, using default service config");
1755
        } else if (serviceConfigError != null) {
1✔
1756
          if (!serviceConfigUpdated) {
1✔
1757
            // First DNS lookup has invalid service config, and cannot fall back to default
1758
            channelLogger.log(
1✔
1759
                ChannelLogLevel.INFO,
1760
                "Fallback to error due to invalid first service config without default config");
1761
            // This error could be an "inappropriate" control plane error that should not bleed
1762
            // through to client code using gRPC. We let them flow through here to the LB as
1763
            // we later check for these error codes when investigating pick results in
1764
            // GrpcUtil.getTransportFromPickResult().
1765
            onError(configOrError.getError());
1✔
1766
            return configOrError.getError();
1✔
1767
          } else {
1768
            effectiveServiceConfig = lastServiceConfig;
1✔
1769
          }
1770
        } else {
1771
          effectiveServiceConfig = EMPTY_SERVICE_CONFIG;
1✔
1772
          realChannel.updateConfigSelector(null);
1✔
1773
        }
1774
        if (!effectiveServiceConfig.equals(lastServiceConfig)) {
1✔
1775
          channelLogger.log(
1✔
1776
              ChannelLogLevel.INFO,
1777
              "Service config changed{0}",
1778
              effectiveServiceConfig == EMPTY_SERVICE_CONFIG ? " to empty" : "");
1✔
1779
          lastServiceConfig = effectiveServiceConfig;
1✔
1780
          transportProvider.throttle = effectiveServiceConfig.getRetryThrottling();
1✔
1781
        }
1782

1783
        try {
1784
          // TODO(creamsoup): when `serversOrError` is empty and lastResolutionStateCopy == SUCCESS
1785
          //  and lbNeedAddress, it shouldn't call the handleServiceConfigUpdate. But,
1786
          //  lbNeedAddress is not deterministic
1787
          serviceConfigUpdated = true;
1✔
1788
        } catch (RuntimeException re) {
×
1789
          logger.log(
×
1790
              Level.WARNING,
1791
              "[" + getLogId() + "] Unexpected exception from parsing service config",
×
1792
              re);
1793
        }
1✔
1794
      }
1795

1796
      Attributes effectiveAttrs = resolutionResult.getAttributes();
1✔
1797
      // Call LB only if it's not shutdown.  If LB is shutdown, lbHelper won't match.
1798
      if (NameResolverListener.this.helper == ManagedChannelImpl.this.lbHelper) {
1✔
1799
        Attributes.Builder attrBuilder =
1✔
1800
            effectiveAttrs.toBuilder().discard(InternalConfigSelector.KEY);
1✔
1801
        Map<String, ?> healthCheckingConfig =
1✔
1802
            effectiveServiceConfig.getHealthCheckingConfig();
1✔
1803
        if (healthCheckingConfig != null) {
1✔
1804
          attrBuilder
1✔
1805
              .set(LoadBalancer.ATTR_HEALTH_CHECKING_CONFIG, healthCheckingConfig)
1✔
1806
              .build();
1✔
1807
        }
1808
        Attributes attributes = attrBuilder.build();
1✔
1809

1810
        ResolvedAddresses.Builder resolvedAddresses = ResolvedAddresses.newBuilder()
1✔
1811
            .setAddresses(serversOrError.getValue())
1✔
1812
            .setAttributes(attributes)
1✔
1813
            .setLoadBalancingPolicyConfig(effectiveServiceConfig.getLoadBalancingConfig());
1✔
1814
        Status addressAcceptanceStatus = helper.lb.tryAcceptResolvedAddresses(
1✔
1815
            resolvedAddresses.build());
1✔
1816
        return addressAcceptanceStatus;
1✔
1817
      }
1818
      return Status.OK;
×
1819
    }
1820

1821
    @Override
1822
    public void onError(final Status error) {
1823
      checkArgument(!error.isOk(), "the error status must not be OK");
1✔
1824
      final class NameResolverErrorHandler implements Runnable {
1✔
1825
        @Override
1826
        public void run() {
1827
          handleErrorInSyncContext(error);
1✔
1828
        }
1✔
1829
      }
1830

1831
      syncContext.execute(new NameResolverErrorHandler());
1✔
1832
    }
1✔
1833

1834
    private void handleErrorInSyncContext(Status error) {
1835
      logger.log(Level.WARNING, "[{0}] Failed to resolve name. status={1}",
1✔
1836
          new Object[] {getLogId(), error});
1✔
1837
      realChannel.onConfigError();
1✔
1838
      if (lastResolutionState != ResolutionState.ERROR) {
1✔
1839
        channelLogger.log(ChannelLogLevel.WARNING, "Failed to resolve name: {0}", error);
1✔
1840
        lastResolutionState = ResolutionState.ERROR;
1✔
1841
      }
1842
      // Call LB only if it's not shutdown.  If LB is shutdown, lbHelper won't match.
1843
      if (NameResolverListener.this.helper != ManagedChannelImpl.this.lbHelper) {
1✔
1844
        return;
1✔
1845
      }
1846

1847
      helper.lb.handleNameResolutionError(error);
1✔
1848
    }
1✔
1849
  }
1850

1851
  private final class SubchannelImpl extends AbstractSubchannel {
1852
    final CreateSubchannelArgs args;
1853
    final InternalLogId subchannelLogId;
1854
    final ChannelLoggerImpl subchannelLogger;
1855
    final ChannelTracer subchannelTracer;
1856
    List<EquivalentAddressGroup> addressGroups;
1857
    InternalSubchannel subchannel;
1858
    boolean started;
1859
    boolean shutdown;
1860
    ScheduledHandle delayedShutdownTask;
1861

1862
    SubchannelImpl(CreateSubchannelArgs args) {
1✔
1863
      checkNotNull(args, "args");
1✔
1864
      addressGroups = args.getAddresses();
1✔
1865
      if (authorityOverride != null) {
1✔
1866
        List<EquivalentAddressGroup> eagsWithoutOverrideAttr =
1✔
1867
            stripOverrideAuthorityAttributes(args.getAddresses());
1✔
1868
        args = args.toBuilder().setAddresses(eagsWithoutOverrideAttr).build();
1✔
1869
      }
1870
      this.args = args;
1✔
1871
      subchannelLogId = InternalLogId.allocate("Subchannel", /*details=*/ authority());
1✔
1872
      subchannelTracer = new ChannelTracer(
1✔
1873
          subchannelLogId, maxTraceEvents, timeProvider.currentTimeNanos(),
1✔
1874
          "Subchannel for " + args.getAddresses());
1✔
1875
      subchannelLogger = new ChannelLoggerImpl(subchannelTracer, timeProvider);
1✔
1876
    }
1✔
1877

1878
    @Override
1879
    public void start(final SubchannelStateListener listener) {
1880
      syncContext.throwIfNotInThisSynchronizationContext();
1✔
1881
      checkState(!started, "already started");
1✔
1882
      checkState(!shutdown, "already shutdown");
1✔
1883
      checkState(!terminating, "Channel is being terminated");
1✔
1884
      started = true;
1✔
1885
      final class ManagedInternalSubchannelCallback extends InternalSubchannel.Callback {
1✔
1886
        // All callbacks are run in syncContext
1887
        @Override
1888
        void onTerminated(InternalSubchannel is) {
1889
          subchannels.remove(is);
1✔
1890
          channelz.removeSubchannel(is);
1✔
1891
          maybeTerminateChannel();
1✔
1892
        }
1✔
1893

1894
        @Override
1895
        void onStateChange(InternalSubchannel is, ConnectivityStateInfo newState) {
1896
          checkState(listener != null, "listener is null");
1✔
1897
          listener.onSubchannelState(newState);
1✔
1898
        }
1✔
1899

1900
        @Override
1901
        void onInUse(InternalSubchannel is) {
1902
          inUseStateAggregator.updateObjectInUse(is, true);
1✔
1903
        }
1✔
1904

1905
        @Override
1906
        void onNotInUse(InternalSubchannel is) {
1907
          inUseStateAggregator.updateObjectInUse(is, false);
1✔
1908
        }
1✔
1909
      }
1910

1911
      final InternalSubchannel internalSubchannel = new InternalSubchannel(
1✔
1912
          args,
1913
          authority(),
1✔
1914
          userAgent,
1✔
1915
          backoffPolicyProvider,
1✔
1916
          transportFactory,
1✔
1917
          transportFactory.getScheduledExecutorService(),
1✔
1918
          stopwatchSupplier,
1✔
1919
          syncContext,
1920
          new ManagedInternalSubchannelCallback(),
1921
          channelz,
1✔
1922
          callTracerFactory.create(),
1✔
1923
          subchannelTracer,
1924
          subchannelLogId,
1925
          subchannelLogger,
1926
          transportFilters);
1✔
1927

1928
      channelTracer.reportEvent(new ChannelTrace.Event.Builder()
1✔
1929
          .setDescription("Child Subchannel started")
1✔
1930
          .setSeverity(ChannelTrace.Event.Severity.CT_INFO)
1✔
1931
          .setTimestampNanos(timeProvider.currentTimeNanos())
1✔
1932
          .setSubchannelRef(internalSubchannel)
1✔
1933
          .build());
1✔
1934

1935
      this.subchannel = internalSubchannel;
1✔
1936
      channelz.addSubchannel(internalSubchannel);
1✔
1937
      subchannels.add(internalSubchannel);
1✔
1938
    }
1✔
1939

1940
    @Override
1941
    InternalInstrumented<ChannelStats> getInstrumentedInternalSubchannel() {
1942
      checkState(started, "not started");
1✔
1943
      return subchannel;
1✔
1944
    }
1945

1946
    @Override
1947
    public void shutdown() {
1948
      syncContext.throwIfNotInThisSynchronizationContext();
1✔
1949
      if (subchannel == null) {
1✔
1950
        // start() was not successful
1951
        shutdown = true;
×
1952
        return;
×
1953
      }
1954
      if (shutdown) {
1✔
1955
        if (terminating && delayedShutdownTask != null) {
1✔
1956
          // shutdown() was previously called when terminating == false, thus a delayed shutdown()
1957
          // was scheduled.  Now since terminating == true, We should expedite the shutdown.
1958
          delayedShutdownTask.cancel();
×
1959
          delayedShutdownTask = null;
×
1960
          // Will fall through to the subchannel.shutdown() at the end.
1961
        } else {
1962
          return;
1✔
1963
        }
1964
      } else {
1965
        shutdown = true;
1✔
1966
      }
1967
      // Add a delay to shutdown to deal with the race between 1) a transport being picked and
1968
      // newStream() being called on it, and 2) its Subchannel is shut down by LoadBalancer (e.g.,
1969
      // because of address change, or because LoadBalancer is shutdown by Channel entering idle
1970
      // mode). If (2) wins, the app will see a spurious error. We work around this by delaying
1971
      // shutdown of Subchannel for a few seconds here.
1972
      //
1973
      // TODO(zhangkun83): consider a better approach
1974
      // (https://github.com/grpc/grpc-java/issues/2562).
1975
      if (!terminating) {
1✔
1976
        final class ShutdownSubchannel implements Runnable {
1✔
1977
          @Override
1978
          public void run() {
1979
            subchannel.shutdown(SUBCHANNEL_SHUTDOWN_STATUS);
1✔
1980
          }
1✔
1981
        }
1982

1983
        delayedShutdownTask = syncContext.schedule(
1✔
1984
            new LogExceptionRunnable(new ShutdownSubchannel()),
1985
            SUBCHANNEL_SHUTDOWN_DELAY_SECONDS, TimeUnit.SECONDS,
1986
            transportFactory.getScheduledExecutorService());
1✔
1987
        return;
1✔
1988
      }
1989
      // When terminating == true, no more real streams will be created. It's safe and also
1990
      // desirable to shutdown timely.
1991
      subchannel.shutdown(SHUTDOWN_STATUS);
1✔
1992
    }
1✔
1993

1994
    @Override
1995
    public void requestConnection() {
1996
      syncContext.throwIfNotInThisSynchronizationContext();
1✔
1997
      checkState(started, "not started");
1✔
1998
      subchannel.obtainActiveTransport();
1✔
1999
    }
1✔
2000

2001
    @Override
2002
    public List<EquivalentAddressGroup> getAllAddresses() {
2003
      syncContext.throwIfNotInThisSynchronizationContext();
1✔
2004
      checkState(started, "not started");
1✔
2005
      return addressGroups;
1✔
2006
    }
2007

2008
    @Override
2009
    public Attributes getAttributes() {
2010
      return args.getAttributes();
1✔
2011
    }
2012

2013
    @Override
2014
    public String toString() {
2015
      return subchannelLogId.toString();
1✔
2016
    }
2017

2018
    @Override
2019
    public Channel asChannel() {
2020
      checkState(started, "not started");
1✔
2021
      return new SubchannelChannel(
1✔
2022
          subchannel, balancerRpcExecutorHolder.getExecutor(),
1✔
2023
          transportFactory.getScheduledExecutorService(),
1✔
2024
          callTracerFactory.create(),
1✔
2025
          new AtomicReference<InternalConfigSelector>(null));
2026
    }
2027

2028
    @Override
2029
    public Object getInternalSubchannel() {
2030
      checkState(started, "Subchannel is not started");
1✔
2031
      return subchannel;
1✔
2032
    }
2033

2034
    @Override
2035
    public ChannelLogger getChannelLogger() {
2036
      return subchannelLogger;
1✔
2037
    }
2038

2039
    @Override
2040
    public void updateAddresses(List<EquivalentAddressGroup> addrs) {
2041
      syncContext.throwIfNotInThisSynchronizationContext();
1✔
2042
      addressGroups = addrs;
1✔
2043
      if (authorityOverride != null) {
1✔
2044
        addrs = stripOverrideAuthorityAttributes(addrs);
1✔
2045
      }
2046
      subchannel.updateAddresses(addrs);
1✔
2047
    }
1✔
2048

2049
    @Override
2050
    public Attributes getConnectedAddressAttributes() {
2051
      return subchannel.getConnectedAddressAttributes();
1✔
2052
    }
2053

2054
    private List<EquivalentAddressGroup> stripOverrideAuthorityAttributes(
2055
        List<EquivalentAddressGroup> eags) {
2056
      List<EquivalentAddressGroup> eagsWithoutOverrideAttr = new ArrayList<>();
1✔
2057
      for (EquivalentAddressGroup eag : eags) {
1✔
2058
        EquivalentAddressGroup eagWithoutOverrideAttr = new EquivalentAddressGroup(
1✔
2059
            eag.getAddresses(),
1✔
2060
            eag.getAttributes().toBuilder().discard(ATTR_AUTHORITY_OVERRIDE).build());
1✔
2061
        eagsWithoutOverrideAttr.add(eagWithoutOverrideAttr);
1✔
2062
      }
1✔
2063
      return Collections.unmodifiableList(eagsWithoutOverrideAttr);
1✔
2064
    }
2065
  }
2066

2067
  @Override
2068
  public String toString() {
2069
    return MoreObjects.toStringHelper(this)
1✔
2070
        .add("logId", logId.getId())
1✔
2071
        .add("target", target)
1✔
2072
        .toString();
1✔
2073
  }
2074

2075
  /**
2076
   * Called from syncContext.
2077
   */
2078
  private final class DelayedTransportListener implements ManagedClientTransport.Listener {
1✔
2079
    @Override
2080
    public void transportShutdown(Status s) {
2081
      checkState(shutdown.get(), "Channel must have been shut down");
1✔
2082
    }
1✔
2083

2084
    @Override
2085
    public void transportReady() {
2086
      // Don't care
2087
    }
×
2088

2089
    @Override
2090
    public Attributes filterTransport(Attributes attributes) {
2091
      return attributes;
×
2092
    }
2093

2094
    @Override
2095
    public void transportInUse(final boolean inUse) {
2096
      inUseStateAggregator.updateObjectInUse(delayedTransport, inUse);
1✔
2097
      if (inUse) {
1✔
2098
        // It's possible to be in idle mode while inUseStateAggregator is in-use, if one of the
2099
        // subchannels is in use. But we should never be in idle mode when delayed transport is in
2100
        // use.
2101
        exitIdleMode();
1✔
2102
      }
2103
    }
1✔
2104

2105
    @Override
2106
    public void transportTerminated() {
2107
      checkState(shutdown.get(), "Channel must have been shut down");
1✔
2108
      terminating = true;
1✔
2109
      shutdownNameResolverAndLoadBalancer(false);
1✔
2110
      // No need to call channelStateManager since we are already in SHUTDOWN state.
2111
      // Until LoadBalancer is shutdown, it may still create new subchannels.  We catch them
2112
      // here.
2113
      maybeShutdownNowSubchannels();
1✔
2114
      maybeTerminateChannel();
1✔
2115
    }
1✔
2116
  }
2117

2118
  /**
2119
   * Must be accessed from syncContext.
2120
   */
2121
  private final class IdleModeStateAggregator extends InUseStateAggregator<Object> {
1✔
2122
    @Override
2123
    protected void handleInUse() {
2124
      exitIdleMode();
1✔
2125
    }
1✔
2126

2127
    @Override
2128
    protected void handleNotInUse() {
2129
      if (shutdown.get()) {
1✔
2130
        return;
1✔
2131
      }
2132
      rescheduleIdleTimer();
1✔
2133
    }
1✔
2134
  }
2135

2136
  /**
2137
   * Lazily request for Executor from an executor pool.
2138
   * Also act as an Executor directly to simply run a cmd
2139
   */
2140
  @VisibleForTesting
2141
  static final class ExecutorHolder implements Executor {
2142
    private final ObjectPool<? extends Executor> pool;
2143
    private Executor executor;
2144

2145
    ExecutorHolder(ObjectPool<? extends Executor> executorPool) {
1✔
2146
      this.pool = checkNotNull(executorPool, "executorPool");
1✔
2147
    }
1✔
2148

2149
    synchronized Executor getExecutor() {
2150
      if (executor == null) {
1✔
2151
        executor = checkNotNull(pool.getObject(), "%s.getObject()", executor);
1✔
2152
      }
2153
      return executor;
1✔
2154
    }
2155

2156
    synchronized void release() {
2157
      if (executor != null) {
1✔
2158
        executor = pool.returnObject(executor);
1✔
2159
      }
2160
    }
1✔
2161

2162
    @Override
2163
    public void execute(Runnable command) {
2164
      getExecutor().execute(command);
1✔
2165
    }
1✔
2166
  }
2167

2168
  private static final class RestrictedScheduledExecutor implements ScheduledExecutorService {
2169
    final ScheduledExecutorService delegate;
2170

2171
    private RestrictedScheduledExecutor(ScheduledExecutorService delegate) {
1✔
2172
      this.delegate = checkNotNull(delegate, "delegate");
1✔
2173
    }
1✔
2174

2175
    @Override
2176
    public <V> ScheduledFuture<V> schedule(Callable<V> callable, long delay, TimeUnit unit) {
2177
      return delegate.schedule(callable, delay, unit);
×
2178
    }
2179

2180
    @Override
2181
    public ScheduledFuture<?> schedule(Runnable cmd, long delay, TimeUnit unit) {
2182
      return delegate.schedule(cmd, delay, unit);
1✔
2183
    }
2184

2185
    @Override
2186
    public ScheduledFuture<?> scheduleAtFixedRate(
2187
        Runnable command, long initialDelay, long period, TimeUnit unit) {
2188
      return delegate.scheduleAtFixedRate(command, initialDelay, period, unit);
1✔
2189
    }
2190

2191
    @Override
2192
    public ScheduledFuture<?> scheduleWithFixedDelay(
2193
        Runnable command, long initialDelay, long delay, TimeUnit unit) {
2194
      return delegate.scheduleWithFixedDelay(command, initialDelay, delay, unit);
×
2195
    }
2196

2197
    @Override
2198
    public boolean awaitTermination(long timeout, TimeUnit unit)
2199
        throws InterruptedException {
2200
      return delegate.awaitTermination(timeout, unit);
×
2201
    }
2202

2203
    @Override
2204
    public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks)
2205
        throws InterruptedException {
2206
      return delegate.invokeAll(tasks);
×
2207
    }
2208

2209
    @Override
2210
    public <T> List<Future<T>> invokeAll(
2211
        Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
2212
        throws InterruptedException {
2213
      return delegate.invokeAll(tasks, timeout, unit);
×
2214
    }
2215

2216
    @Override
2217
    public <T> T invokeAny(Collection<? extends Callable<T>> tasks)
2218
        throws InterruptedException, ExecutionException {
2219
      return delegate.invokeAny(tasks);
×
2220
    }
2221

2222
    @Override
2223
    public <T> T invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit)
2224
        throws InterruptedException, ExecutionException, TimeoutException {
2225
      return delegate.invokeAny(tasks, timeout, unit);
×
2226
    }
2227

2228
    @Override
2229
    public boolean isShutdown() {
2230
      return delegate.isShutdown();
×
2231
    }
2232

2233
    @Override
2234
    public boolean isTerminated() {
2235
      return delegate.isTerminated();
×
2236
    }
2237

2238
    @Override
2239
    public void shutdown() {
2240
      throw new UnsupportedOperationException("Restricted: shutdown() is not allowed");
1✔
2241
    }
2242

2243
    @Override
2244
    public List<Runnable> shutdownNow() {
2245
      throw new UnsupportedOperationException("Restricted: shutdownNow() is not allowed");
1✔
2246
    }
2247

2248
    @Override
2249
    public <T> Future<T> submit(Callable<T> task) {
2250
      return delegate.submit(task);
×
2251
    }
2252

2253
    @Override
2254
    public Future<?> submit(Runnable task) {
2255
      return delegate.submit(task);
×
2256
    }
2257

2258
    @Override
2259
    public <T> Future<T> submit(Runnable task, T result) {
2260
      return delegate.submit(task, result);
×
2261
    }
2262

2263
    @Override
2264
    public void execute(Runnable command) {
2265
      delegate.execute(command);
×
2266
    }
×
2267
  }
2268

2269
  /**
2270
   * A ResolutionState indicates the status of last name resolution.
2271
   */
2272
  enum ResolutionState {
1✔
2273
    NO_RESOLUTION,
1✔
2274
    SUCCESS,
1✔
2275
    ERROR
1✔
2276
  }
2277
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc