#18822

Committed 07 Sep 2023 08:15PM UTC coverage: 88.321% (+0.02%) from 88.302%

Build # #18822

Build Type

push

github-actions

Committed by

ejona86

Commit Message

netty: Touch ByteBuf when message framing has been decoded

When a memory leak occurs, it is really helpful to have access records
to understand where the buffer was being held when it leaked. retain()
when we create the NettyReadableBuffer already creates an access record
the ByteBuf, so here we track when the ByteBuf is passed to another
thread.

See #8330

Run Details

30349 of 34362 relevant lines covered (88.32%)

0.88 hits per line

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

90.63

/../netty/src/main/java/io/grpc/netty/ClientTransportLifecycleManager.java

/*
 * Copyright 2016 The gRPC Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.grpc.netty;

import com.google.errorprone.annotations.CanIgnoreReturnValue;
import io.grpc.Status;
import io.grpc.internal.ManagedClientTransport;

/** Maintainer of transport lifecycle status. */
final class ClientTransportLifecycleManager {
  private final ManagedClientTransport.Listener listener;
  private boolean transportReady;
  private boolean transportShutdown;
  private boolean transportInUse;
  /** null iff !transportShutdown. */
  private Status shutdownStatus;
  /** null iff !transportShutdown. */
  private Throwable shutdownThrowable;
  private boolean transportTerminated;

  public ClientTransportLifecycleManager(ManagedClientTransport.Listener listener) {
    this.listener = listener;
  }

  public void notifyReady() {
    if (transportReady || transportShutdown) {
      return;
    }
    transportReady = true;
    listener.transportReady();
  }

  /**
   * Marks transport as shutdown, but does not set the error status. This must eventually be
   * followed by a call to notifyShutdown.
   */
  public void notifyGracefulShutdown(Status s) {
    if (transportShutdown) {
      return;
    }
    transportShutdown = true;
    listener.transportShutdown(s);
  }

  /** Returns {@code true} if was the first shutdown. */
  @CanIgnoreReturnValue
  public boolean notifyShutdown(Status s) {
    notifyGracefulShutdown(s);
    if (shutdownStatus != null) {
      return false;
    }
    shutdownStatus = s;
    shutdownThrowable = s.asException();
    return true;
  }

  public void notifyInUse(boolean inUse) {
    if (inUse == transportInUse) {
      return;
    }
    transportInUse = inUse;
    listener.transportInUse(inUse);
  }

  public void notifyTerminated(Status s) {
    if (transportTerminated) {
      return;
    }
    transportTerminated = true;
    notifyShutdown(s);
    listener.transportTerminated();
  }

  public Status getShutdownStatus() {
    return shutdownStatus;
  }

  public Throwable getShutdownThrowable() {
    return shutdownThrowable;
  }
}

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.netty;
18
19	import com.google.errorprone.annotations.CanIgnoreReturnValue;
20	import io.grpc.Status;
21	import io.grpc.internal.ManagedClientTransport;
22
23	/** Maintainer of transport lifecycle status. */
24	final class ClientTransportLifecycleManager {
25	private final ManagedClientTransport.Listener listener;
26	private boolean transportReady;
27	private boolean transportShutdown;
28	private boolean transportInUse;
29	/** null iff !transportShutdown. */
30	private Status shutdownStatus;
31	/** null iff !transportShutdown. */
32	private Throwable shutdownThrowable;
33	private boolean transportTerminated;
34
35	public ClientTransportLifecycleManager(ManagedClientTransport.Listener listener) {	1✔
36	this.listener = listener;	1✔
37	}	1✔
38
39	public void notifyReady() {
40	if (transportReady \|\| transportShutdown) {	1✔
41	return;	×
42	}
43	transportReady = true;	1✔
44	listener.transportReady();	1✔
45	}	1✔
46
47	/**
48	* Marks transport as shutdown, but does not set the error status. This must eventually be
49	* followed by a call to notifyShutdown.
50	*/
51	public void notifyGracefulShutdown(Status s) {
52	if (transportShutdown) {	1✔
53	return;	1✔
54	}
55	transportShutdown = true;	1✔
56	listener.transportShutdown(s);	1✔
57	}	1✔
58
59	/** Returns {@code true} if was the first shutdown. */
60	@CanIgnoreReturnValue
61	public boolean notifyShutdown(Status s) {
62	notifyGracefulShutdown(s);	1✔
63	if (shutdownStatus != null) {	1✔
64	return false;	1✔
65	}
66	shutdownStatus = s;	1✔
67	shutdownThrowable = s.asException();	1✔
68	return true;	1✔
69	}
70
71	public void notifyInUse(boolean inUse) {
72	if (inUse == transportInUse) {	1✔
73	return;	×
74	}
75	transportInUse = inUse;	1✔
76	listener.transportInUse(inUse);	1✔
77	}	1✔
78
79	public void notifyTerminated(Status s) {
80	if (transportTerminated) {	1✔
81	return;	×
82	}
83	transportTerminated = true;	1✔
84	notifyShutdown(s);	1✔
85	listener.transportTerminated();	1✔
86	}	1✔
87
88	public Status getShutdownStatus() {
89	return shutdownStatus;	1✔
90	}
91
92	public Throwable getShutdownThrowable() {
93	return shutdownThrowable;	1✔
94	}
95	}

grpc / grpc-java / #18822

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

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