#19441

Committed 29 Aug 2024 08:13PM UTC coverage: 84.505% (+0.01%) from 84.494%

Build # #19441

Build Type

push

github

Committed by

ejona86

Commit Message

Focus MultiChildLB updates around ResolvedAddresses of children

This makes ClusterManagerLB more straight-forward, focusing on just the
things that are relevant to it, and it avoids specialized map key
handling in updateChildrenWithResolvedAddresses().

Run Details

33387 of 39509 relevant lines covered (84.5%)

0.85 hits per line

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

95.97

/../util/src/main/java/io/grpc/util/MultiChildLoadBalancer.java

/*
 * Copyright 2023 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.util;

import static com.google.common.base.Preconditions.checkNotNull;
import static io.grpc.ConnectivityState.CONNECTING;
import static io.grpc.ConnectivityState.IDLE;
import static io.grpc.ConnectivityState.READY;
import static io.grpc.ConnectivityState.SHUTDOWN;
import static io.grpc.ConnectivityState.TRANSIENT_FAILURE;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableList;
import io.grpc.Attributes;
import io.grpc.ConnectivityState;
import io.grpc.EquivalentAddressGroup;
import io.grpc.Internal;
import io.grpc.LoadBalancer;
import io.grpc.LoadBalancerProvider;
import io.grpc.Status;
import io.grpc.internal.PickFirstLoadBalancerProvider;
import java.net.SocketAddress;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.Nullable;

/**
 * A base load balancing policy for those policies which has multiple children such as
 * ClusterManager or the petiole policies.  For internal use only.
 */
@Internal
public abstract class MultiChildLoadBalancer extends LoadBalancer {

  private static final Logger logger = Logger.getLogger(MultiChildLoadBalancer.class.getName());
  private final Map<Object, ChildLbState> childLbStates = new LinkedHashMap<>();
  private final Helper helper;
  // Set to true if currently in the process of handling resolved addresses.
  protected boolean resolvingAddresses;

  protected final LoadBalancerProvider pickFirstLbProvider = new PickFirstLoadBalancerProvider();

  protected ConnectivityState currentConnectivityState;


  protected MultiChildLoadBalancer(Helper helper) {
    this.helper = checkNotNull(helper, "helper");
    logger.log(Level.FINE, "Created");
  }

  /**
   * Using the state of all children will calculate the current connectivity state,
   * update fields, generate a picker and then call
   * {@link Helper#updateBalancingState(ConnectivityState, SubchannelPicker)}.
   */
  protected abstract void updateOverallBalancingState();

  /**
   * Override to utilize parsing of the policy configuration or alternative helper/lb generation.
   * Override this if keys are not Endpoints or if child policies have configuration.
   */
  protected Map<Object, ResolvedAddresses> createChildAddressesMap(
      ResolvedAddresses resolvedAddresses) {
    Map<Object, ResolvedAddresses> childAddresses = new HashMap<>();
    for (EquivalentAddressGroup eag : resolvedAddresses.getAddresses()) {
      ResolvedAddresses addresses = resolvedAddresses.toBuilder()
          .setAddresses(Collections.singletonList(eag))
          .setAttributes(Attributes.newBuilder().set(IS_PETIOLE_POLICY, true).build())
          .setLoadBalancingPolicyConfig(null)
          .build();
      childAddresses.put(new Endpoint(eag), addresses);
    }
    return childAddresses;
  }

  /**
   * Override to create an instance of a subclass.
   */
  protected ChildLbState createChildLbState(Object key) {
    return new ChildLbState(key, pickFirstLbProvider);
  }

  /**
   *   Override to completely replace the default logic or to do additional activities.
   */
  @Override
  public Status acceptResolvedAddresses(ResolvedAddresses resolvedAddresses) {
    try {
      resolvingAddresses = true;

      // process resolvedAddresses to update children
      AcceptResolvedAddrRetVal acceptRetVal = acceptResolvedAddressesInternal(resolvedAddresses);
      if (!acceptRetVal.status.isOk()) {
        return acceptRetVal.status;
      }

      // Update the picker and our connectivity state
      updateOverallBalancingState();

      // shutdown removed children
      shutdownRemoved(acceptRetVal.removedChildren);
      return acceptRetVal.status;
    } finally {
      resolvingAddresses = false;
    }
  }

  /**
   * Handle the name resolution error.
   *
   * <p/>Override if you need special handling.
   */
  @Override
  public void handleNameResolutionError(Status error) {
    if (currentConnectivityState != READY)  {
      helper.updateBalancingState(
          TRANSIENT_FAILURE, new FixedResultPicker(PickResult.withError(error)));
    }
  }

  @Override
  public void shutdown() {
    logger.log(Level.FINE, "Shutdown");
    for (ChildLbState state : childLbStates.values()) {
      state.shutdown();
    }
    childLbStates.clear();
  }

  /**
   *   This does the work to update the child map and calculate which children have been removed.
   *   You must call {@link #updateOverallBalancingState} to update the picker
   *   and call {@link #shutdownRemoved(List)} to shutdown the endpoints that have been removed.
    */
  protected final AcceptResolvedAddrRetVal acceptResolvedAddressesInternal(
      ResolvedAddresses resolvedAddresses) {
    logger.log(Level.FINE, "Received resolution result: {0}", resolvedAddresses);

    Map<Object, ResolvedAddresses> newChildAddresses = createChildAddressesMap(resolvedAddresses);

    // Handle error case
    if (newChildAddresses.isEmpty()) {
      Status unavailableStatus = Status.UNAVAILABLE.withDescription(
          "NameResolver returned no usable address. " + resolvedAddresses);
      handleNameResolutionError(unavailableStatus);
      return new AcceptResolvedAddrRetVal(unavailableStatus, null);
    }

    updateChildrenWithResolvedAddresses(newChildAddresses);

    return new AcceptResolvedAddrRetVal(Status.OK, getRemovedChildren(newChildAddresses.keySet()));
  }

  private void updateChildrenWithResolvedAddresses(
      Map<Object, ResolvedAddresses> newChildAddresses) {
    for (Map.Entry<Object, ResolvedAddresses> entry : newChildAddresses.entrySet()) {
      ChildLbState childLbState = childLbStates.get(entry.getKey());
      if (childLbState == null) {
        childLbState = createChildLbState(entry.getKey());
        childLbStates.put(entry.getKey(), childLbState);
      }
      childLbState.setResolvedAddresses(entry.getValue()); // update child
      childLbState.lb.handleResolvedAddresses(entry.getValue()); // update child LB
    }
  }

  /**
   * Identifies which children have been removed (are not part of the newChildKeys).
   */
  private List<ChildLbState> getRemovedChildren(Set<Object> newChildKeys) {
    List<ChildLbState> removedChildren = new ArrayList<>();
    // Do removals
    for (Object key : ImmutableList.copyOf(childLbStates.keySet())) {
      if (!newChildKeys.contains(key)) {
        ChildLbState childLbState = childLbStates.remove(key);
        removedChildren.add(childLbState);
      }
    }
    return removedChildren;
  }

  protected final void shutdownRemoved(List<ChildLbState> removedChildren) {
    // Do shutdowns after updating picker to reduce the chance of failing an RPC by picking a
    // subchannel that has been shutdown.
    for (ChildLbState childLbState : removedChildren) {
      childLbState.shutdown();
    }
  }

  @Nullable
  protected static ConnectivityState aggregateState(
      @Nullable ConnectivityState overallState, ConnectivityState childState) {
    if (overallState == null) {
      return childState;
    }
    if (overallState == READY || childState == READY) {
      return READY;
    }
    if (overallState == CONNECTING || childState == CONNECTING) {
      return CONNECTING;
    }
    if (overallState == IDLE || childState == IDLE) {
      return IDLE;
    }
    return overallState;
  }

  protected final Helper getHelper() {
    return helper;
  }

  @VisibleForTesting
  public final Collection<ChildLbState> getChildLbStates() {
    return childLbStates.values();
  }

  @VisibleForTesting
  public final ChildLbState getChildLbState(Object key) {
    if (key == null) {
      return null;
    }
    if (key instanceof EquivalentAddressGroup) {
      key = new Endpoint((EquivalentAddressGroup) key);
    }
    return childLbStates.get(key);
  }

  @VisibleForTesting
  public final ChildLbState getChildLbStateEag(EquivalentAddressGroup eag) {
    return getChildLbState(new Endpoint(eag));
  }

  /**
   * Filters out non-ready child load balancers (subchannels).
   */
  protected final List<ChildLbState> getReadyChildren() {
    List<ChildLbState> activeChildren = new ArrayList<>();
    for (ChildLbState child : getChildLbStates()) {
      if (child.getCurrentState() == READY) {
        activeChildren.add(child);
      }
    }
    return activeChildren;
  }

  /**
   * This represents the state of load balancer children.  Each endpoint (represented by an
   * EquivalentAddressGroup or EDS string) will have a separate ChildLbState which in turn will
   * have a single child LoadBalancer created from the provided factory.
   *
   * <p>A ChildLbStateHelper is the glue between ChildLbState and the helpers associated with the
   * petiole policy above and the PickFirstLoadBalancer's helper below.
   *
   * <p>If you wish to store additional state information related to each subchannel, then extend
   * this class.
   */
  public class ChildLbState {
    private final Object key;
    private ResolvedAddresses resolvedAddresses;

    private final LoadBalancer lb;
    private ConnectivityState currentState;
    private SubchannelPicker currentPicker = new FixedResultPicker(PickResult.withNoResult());

    public ChildLbState(Object key, LoadBalancer.Factory policyFactory) {
      this.key = key;
      this.lb = policyFactory.newLoadBalancer(createChildHelper());
      this.currentState = CONNECTING;
    }

    protected ChildLbStateHelper createChildHelper() {
      return new ChildLbStateHelper();
    }

    /**
     * Override for unique behavior such as delayed shutdowns of subchannels.
     */
    protected void shutdown() {
      lb.shutdown();
      this.currentState = SHUTDOWN;
      logger.log(Level.FINE, "Child balancer {0} deleted", key);
    }

    @Override
    public String toString() {
      return "Address = " + key
          + ", state = " + currentState
          + ", picker type: " + currentPicker.getClass()
          + ", lb: " + lb;
    }

    public final Object getKey() {
      return key;
    }

    @VisibleForTesting
    public final LoadBalancer getLb() {
      return lb;
    }

    @VisibleForTesting
    public final SubchannelPicker getCurrentPicker() {
      return currentPicker;
    }

    public final ConnectivityState getCurrentState() {
      return currentState;
    }

    protected final void setCurrentState(ConnectivityState newState) {
      currentState = newState;
    }

    protected final void setCurrentPicker(SubchannelPicker newPicker) {
      currentPicker = newPicker;
    }

    public final EquivalentAddressGroup getEag() {
      if (resolvedAddresses == null || resolvedAddresses.getAddresses().isEmpty()) {
        return null;
      }
      return resolvedAddresses.getAddresses().get(0);
    }

    protected final void setResolvedAddresses(ResolvedAddresses newAddresses) {
      checkNotNull(newAddresses, "Missing address list for child");
      resolvedAddresses = newAddresses;
    }

    @VisibleForTesting
    public final ResolvedAddresses getResolvedAddresses() {
      return resolvedAddresses;
    }

    /**
     * ChildLbStateHelper is the glue between ChildLbState and the helpers associated with the
     * petiole policy above and the PickFirstLoadBalancer's helper below.
     *
     * <p>The ChildLbState updates happen during updateBalancingState.  Otherwise, it is doing
     * simple forwarding.
     */
    protected class ChildLbStateHelper extends ForwardingLoadBalancerHelper {

      /**
       * Update current state and picker for this child and then use
       * {@link #updateOverallBalancingState()} for the parent LB.
       */
      @Override
      public void updateBalancingState(final ConnectivityState newState,
          final SubchannelPicker newPicker) {
        if (currentState == SHUTDOWN) {
          return;
        }

        currentState = newState;
        currentPicker = newPicker;
        // If we are already in the process of resolving addresses, the overall balancing state
        // will be updated at the end of it, and we don't need to trigger that update here.
        if (!resolvingAddresses) {
          updateOverallBalancingState();
        }
      }

      @Override
      protected Helper delegate() {
        return helper;
      }
    }
  }

  /**
   * Endpoint is an optimization to quickly lookup and compare EquivalentAddressGroup address sets.
   * It ignores the attributes. Is used as a key for ChildLbState for most load balancers
   * (ClusterManagerLB uses a String).
   */
  protected static class Endpoint {
    final Collection<SocketAddress> addrs;
    final int hashCode;

    public Endpoint(EquivalentAddressGroup eag) {
      checkNotNull(eag, "eag");

      if (eag.getAddresses().size() < 10) {
        addrs = eag.getAddresses();
      } else {
        // This is expected to be very unlikely in practice
        addrs = new HashSet<>(eag.getAddresses());
      }
      int sum = 0;
      for (SocketAddress address : eag.getAddresses()) {
        sum += address.hashCode();
      }
      hashCode = sum;
    }

    @Override
    public int hashCode() {
      return hashCode;
    }

    @Override
    public boolean equals(Object other) {
      if (this == other) {
        return true;
      }

      if (!(other instanceof Endpoint)) {
        return false;
      }
      Endpoint o = (Endpoint) other;
      if (o.hashCode != hashCode || o.addrs.size() != addrs.size()) {
        return false;
      }

      return o.addrs.containsAll(addrs);
    }

    @Override
    public String toString() {
      return addrs.toString();
    }
  }

  protected static class AcceptResolvedAddrRetVal {
    public final Status status;
    public final List<ChildLbState> removedChildren;

    public AcceptResolvedAddrRetVal(Status status, List<ChildLbState> removedChildren) {
      this.status = status;
      this.removedChildren = removedChildren;
    }
  }
}

1	/*
2	* Copyright 2023 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.util;
18
19	import static com.google.common.base.Preconditions.checkNotNull;
20	import static io.grpc.ConnectivityState.CONNECTING;
21	import static io.grpc.ConnectivityState.IDLE;
22	import static io.grpc.ConnectivityState.READY;
23	import static io.grpc.ConnectivityState.SHUTDOWN;
24	import static io.grpc.ConnectivityState.TRANSIENT_FAILURE;
25
26	import com.google.common.annotations.VisibleForTesting;
27	import com.google.common.collect.ImmutableList;
28	import io.grpc.Attributes;
29	import io.grpc.ConnectivityState;
30	import io.grpc.EquivalentAddressGroup;
31	import io.grpc.Internal;
32	import io.grpc.LoadBalancer;
33	import io.grpc.LoadBalancerProvider;
34	import io.grpc.Status;
35	import io.grpc.internal.PickFirstLoadBalancerProvider;
36	import java.net.SocketAddress;
37	import java.util.ArrayList;
38	import java.util.Collection;
39	import java.util.Collections;
40	import java.util.HashMap;
41	import java.util.HashSet;
42	import java.util.LinkedHashMap;
43	import java.util.List;
44	import java.util.Map;
45	import java.util.Set;
46	import java.util.logging.Level;
47	import java.util.logging.Logger;
48	import javax.annotation.Nullable;
49
50	/**
51	* A base load balancing policy for those policies which has multiple children such as
52	* ClusterManager or the petiole policies. For internal use only.
53	*/
54	@Internal
55	public abstract class MultiChildLoadBalancer extends LoadBalancer {
56
57	private static final Logger logger = Logger.getLogger(MultiChildLoadBalancer.class.getName());	1✔
58	private final Map<Object, ChildLbState> childLbStates = new LinkedHashMap<>();	1✔
59	private final Helper helper;
60	// Set to true if currently in the process of handling resolved addresses.
61	protected boolean resolvingAddresses;
62
63	protected final LoadBalancerProvider pickFirstLbProvider = new PickFirstLoadBalancerProvider();	1✔
64
65	protected ConnectivityState currentConnectivityState;
66
67
68	protected MultiChildLoadBalancer(Helper helper) {	1✔
69	this.helper = checkNotNull(helper, "helper");	1✔
70	logger.log(Level.FINE, "Created");	1✔
71	}	1✔
72
73	/**
74	* Using the state of all children will calculate the current connectivity state,
75	* update fields, generate a picker and then call
76	* {@link Helper#updateBalancingState(ConnectivityState, SubchannelPicker)}.
77	*/
78	protected abstract void updateOverallBalancingState();
79
80	/**
81	* Override to utilize parsing of the policy configuration or alternative helper/lb generation.
82	* Override this if keys are not Endpoints or if child policies have configuration.
83	*/
84	protected Map<Object, ResolvedAddresses> createChildAddressesMap(
85	ResolvedAddresses resolvedAddresses) {
86	Map<Object, ResolvedAddresses> childAddresses = new HashMap<>();	1✔
87	for (EquivalentAddressGroup eag : resolvedAddresses.getAddresses()) {	1✔
88	ResolvedAddresses addresses = resolvedAddresses.toBuilder()	1✔
89	.setAddresses(Collections.singletonList(eag))	1✔
90	.setAttributes(Attributes.newBuilder().set(IS_PETIOLE_POLICY, true).build())	1✔
91	.setLoadBalancingPolicyConfig(null)	1✔
92	.build();	1✔
93	childAddresses.put(new Endpoint(eag), addresses);	1✔
94	}	1✔
95	return childAddresses;	1✔
96	}
97
98	/**
99	* Override to create an instance of a subclass.
100	*/
101	protected ChildLbState createChildLbState(Object key) {
102	return new ChildLbState(key, pickFirstLbProvider);	1✔
103	}
104
105	/**
106	* Override to completely replace the default logic or to do additional activities.
107	*/
108	@Override
109	public Status acceptResolvedAddresses(ResolvedAddresses resolvedAddresses) {
110	try {
111	resolvingAddresses = true;	1✔
112
113	// process resolvedAddresses to update children
114	AcceptResolvedAddrRetVal acceptRetVal = acceptResolvedAddressesInternal(resolvedAddresses);	1✔
115	if (!acceptRetVal.status.isOk()) {	1✔
116	return acceptRetVal.status;	1✔
117	}
118
119	// Update the picker and our connectivity state
120	updateOverallBalancingState();	1✔
121
122	// shutdown removed children
123	shutdownRemoved(acceptRetVal.removedChildren);	1✔
124	return acceptRetVal.status;	1✔
125	} finally {
126	resolvingAddresses = false;	1✔
127	}
128	}
129
130	/**
131	* Handle the name resolution error.
132	*
133	* <p/>Override if you need special handling.
134	*/
135	@Override
136	public void handleNameResolutionError(Status error) {
137	if (currentConnectivityState != READY) {	1✔
138	helper.updateBalancingState(	1✔
139	TRANSIENT_FAILURE, new FixedResultPicker(PickResult.withError(error)));	1✔
140	}
141	}	1✔
142
143	@Override
144	public void shutdown() {
145	logger.log(Level.FINE, "Shutdown");	1✔
146	for (ChildLbState state : childLbStates.values()) {	1✔
147	state.shutdown();	1✔
148	}	1✔
149	childLbStates.clear();	1✔
150	}	1✔
151
152	/**
153	* This does the work to update the child map and calculate which children have been removed.
154	* You must call {@link #updateOverallBalancingState} to update the picker
155	* and call {@link #shutdownRemoved(List)} to shutdown the endpoints that have been removed.
156	*/
157	protected final AcceptResolvedAddrRetVal acceptResolvedAddressesInternal(
158	ResolvedAddresses resolvedAddresses) {
159	logger.log(Level.FINE, "Received resolution result: {0}", resolvedAddresses);	1✔
160
161	Map<Object, ResolvedAddresses> newChildAddresses = createChildAddressesMap(resolvedAddresses);	1✔
162
163	// Handle error case
164	if (newChildAddresses.isEmpty()) {	1✔
165	Status unavailableStatus = Status.UNAVAILABLE.withDescription(	1✔
166	"NameResolver returned no usable address. " + resolvedAddresses);
167	handleNameResolutionError(unavailableStatus);	1✔
168	return new AcceptResolvedAddrRetVal(unavailableStatus, null);	1✔
169	}
170
171	updateChildrenWithResolvedAddresses(newChildAddresses);	1✔
172
173	return new AcceptResolvedAddrRetVal(Status.OK, getRemovedChildren(newChildAddresses.keySet()));	1✔
174	}
175
176	private void updateChildrenWithResolvedAddresses(
177	Map<Object, ResolvedAddresses> newChildAddresses) {
178	for (Map.Entry<Object, ResolvedAddresses> entry : newChildAddresses.entrySet()) {	1✔
179	ChildLbState childLbState = childLbStates.get(entry.getKey());	1✔
180	if (childLbState == null) {	1✔
181	childLbState = createChildLbState(entry.getKey());	1✔
182	childLbStates.put(entry.getKey(), childLbState);	1✔
183	}
184	childLbState.setResolvedAddresses(entry.getValue()); // update child	1✔
185	childLbState.lb.handleResolvedAddresses(entry.getValue()); // update child LB	1✔
186	}	1✔
187	}	1✔
188
189	/**
190	* Identifies which children have been removed (are not part of the newChildKeys).
191	*/
192	private List<ChildLbState> getRemovedChildren(Set<Object> newChildKeys) {
193	List<ChildLbState> removedChildren = new ArrayList<>();	1✔
194	// Do removals
195	for (Object key : ImmutableList.copyOf(childLbStates.keySet())) {	1✔
196	if (!newChildKeys.contains(key)) {	1✔
197	ChildLbState childLbState = childLbStates.remove(key);	1✔
198	removedChildren.add(childLbState);	1✔
199	}
200	}	1✔
201	return removedChildren;	1✔
202	}
203
204	protected final void shutdownRemoved(List<ChildLbState> removedChildren) {
205	// Do shutdowns after updating picker to reduce the chance of failing an RPC by picking a
206	// subchannel that has been shutdown.
207	for (ChildLbState childLbState : removedChildren) {	1✔
208	childLbState.shutdown();	1✔
209	}	1✔
210	}	1✔
211
212	@Nullable
213	protected static ConnectivityState aggregateState(
214	@Nullable ConnectivityState overallState, ConnectivityState childState) {
215	if (overallState == null) {	1✔
216	return childState;	1✔
217	}
218	if (overallState == READY \|\| childState == READY) {	1✔
219	return READY;	1✔
220	}
221	if (overallState == CONNECTING \|\| childState == CONNECTING) {	1✔
222	return CONNECTING;	1✔
223	}
224	if (overallState == IDLE \|\| childState == IDLE) {	1✔
225	return IDLE;	×
226	}
227	return overallState;	1✔
228	}
229
230	protected final Helper getHelper() {
231	return helper;	1✔
232	}
233
234	@VisibleForTesting
235	public final Collection<ChildLbState> getChildLbStates() {
236	return childLbStates.values();	1✔
237	}
238
239	@VisibleForTesting
240	public final ChildLbState getChildLbState(Object key) {
241	if (key == null) {	1✔
242	return null;	×
243	}
244	if (key instanceof EquivalentAddressGroup) {	1✔
245	key = new Endpoint((EquivalentAddressGroup) key);	1✔
246	}
247	return childLbStates.get(key);	1✔
248	}
249
250	@VisibleForTesting
251	public final ChildLbState getChildLbStateEag(EquivalentAddressGroup eag) {
252	return getChildLbState(new Endpoint(eag));	1✔
253	}
254
255	/**
256	* Filters out non-ready child load balancers (subchannels).
257	*/
258	protected final List<ChildLbState> getReadyChildren() {
259	List<ChildLbState> activeChildren = new ArrayList<>();	1✔
260	for (ChildLbState child : getChildLbStates()) {	1✔
261	if (child.getCurrentState() == READY) {	1✔
262	activeChildren.add(child);	1✔
263	}
264	}	1✔
265	return activeChildren;	1✔
266	}
267
268	/**
269	* This represents the state of load balancer children. Each endpoint (represented by an
270	* EquivalentAddressGroup or EDS string) will have a separate ChildLbState which in turn will
271	* have a single child LoadBalancer created from the provided factory.
272	*
273	* <p>A ChildLbStateHelper is the glue between ChildLbState and the helpers associated with the
274	* petiole policy above and the PickFirstLoadBalancer's helper below.
275	*
276	* <p>If you wish to store additional state information related to each subchannel, then extend
277	* this class.
278	*/
279	public class ChildLbState {
280	private final Object key;
281	private ResolvedAddresses resolvedAddresses;
282
283	private final LoadBalancer lb;
284	private ConnectivityState currentState;
285	private SubchannelPicker currentPicker = new FixedResultPicker(PickResult.withNoResult());	1✔
286
287	public ChildLbState(Object key, LoadBalancer.Factory policyFactory) {	1✔
288	this.key = key;	1✔
289	this.lb = policyFactory.newLoadBalancer(createChildHelper());	1✔
290	this.currentState = CONNECTING;	1✔
291	}	1✔
292
293	protected ChildLbStateHelper createChildHelper() {
294	return new ChildLbStateHelper();	1✔
295	}
296
297	/**
298	* Override for unique behavior such as delayed shutdowns of subchannels.
299	*/
300	protected void shutdown() {
301	lb.shutdown();	1✔
302	this.currentState = SHUTDOWN;	1✔
303	logger.log(Level.FINE, "Child balancer {0} deleted", key);	1✔
304	}	1✔
305
306	@Override
307	public String toString() {
308	return "Address = " + key	×
309	+ ", state = " + currentState
310	+ ", picker type: " + currentPicker.getClass()	×
311	+ ", lb: " + lb;
312	}
313
314	public final Object getKey() {
315	return key;	1✔
316	}
317
318	@VisibleForTesting
319	public final LoadBalancer getLb() {
320	return lb;	1✔
321	}
322
323	@VisibleForTesting
324	public final SubchannelPicker getCurrentPicker() {
325	return currentPicker;	1✔
326	}
327
328	public final ConnectivityState getCurrentState() {
329	return currentState;	1✔
330	}
331
332	protected final void setCurrentState(ConnectivityState newState) {
333	currentState = newState;	1✔
334	}	1✔
335
336	protected final void setCurrentPicker(SubchannelPicker newPicker) {
337	currentPicker = newPicker;	1✔
338	}	1✔
339
340	public final EquivalentAddressGroup getEag() {
341	if (resolvedAddresses == null \|\| resolvedAddresses.getAddresses().isEmpty()) {	1✔
342	return null;	×
343	}
344	return resolvedAddresses.getAddresses().get(0);	1✔
345	}
346
347	protected final void setResolvedAddresses(ResolvedAddresses newAddresses) {
348	checkNotNull(newAddresses, "Missing address list for child");	1✔
349	resolvedAddresses = newAddresses;	1✔
350	}	1✔
351
352	@VisibleForTesting
353	public final ResolvedAddresses getResolvedAddresses() {
354	return resolvedAddresses;	1✔
355	}
356
357	/**
358	* ChildLbStateHelper is the glue between ChildLbState and the helpers associated with the
359	* petiole policy above and the PickFirstLoadBalancer's helper below.
360	*
361	* <p>The ChildLbState updates happen during updateBalancingState. Otherwise, it is doing
362	* simple forwarding.
363	*/
364	protected class ChildLbStateHelper extends ForwardingLoadBalancerHelper {	1✔
365
366	/**
367	* Update current state and picker for this child and then use
368	* {@link #updateOverallBalancingState()} for the parent LB.
369	*/
370	@Override
371	public void updateBalancingState(final ConnectivityState newState,
372	final SubchannelPicker newPicker) {
373	if (currentState == SHUTDOWN) {	1✔
374	return;	×
375	}
376
377	currentState = newState;	1✔
378	currentPicker = newPicker;	1✔
379	// If we are already in the process of resolving addresses, the overall balancing state
380	// will be updated at the end of it, and we don't need to trigger that update here.
381	if (!resolvingAddresses) {	1✔
382	updateOverallBalancingState();	1✔
383	}
384	}	1✔
385
386	@Override
387	protected Helper delegate() {
388	return helper;	1✔
389	}
390	}
391	}
392
393	/**
394	* Endpoint is an optimization to quickly lookup and compare EquivalentAddressGroup address sets.
395	* It ignores the attributes. Is used as a key for ChildLbState for most load balancers
396	* (ClusterManagerLB uses a String).
397	*/
398	protected static class Endpoint {
399	final Collection<SocketAddress> addrs;
400	final int hashCode;
401
402	public Endpoint(EquivalentAddressGroup eag) {	1✔
403	checkNotNull(eag, "eag");	1✔
404
405	if (eag.getAddresses().size() < 10) {	1✔
406	addrs = eag.getAddresses();	1✔
407	} else {
408	// This is expected to be very unlikely in practice
409	addrs = new HashSet<>(eag.getAddresses());	1✔
410	}
411	int sum = 0;	1✔
412	for (SocketAddress address : eag.getAddresses()) {	1✔
413	sum += address.hashCode();	1✔
414	}	1✔
415	hashCode = sum;	1✔
416	}	1✔
417
418	@Override
419	public int hashCode() {
420	return hashCode;	1✔
421	}
422
423	@Override
424	public boolean equals(Object other) {
425	if (this == other) {	1✔
426	return true;	1✔
427	}
428
429	if (!(other instanceof Endpoint)) {	1✔
430	return false;	1✔
431	}
432	Endpoint o = (Endpoint) other;	1✔
433	if (o.hashCode != hashCode \|\| o.addrs.size() != addrs.size()) {	1✔
434	return false;	1✔
435	}
436
437	return o.addrs.containsAll(addrs);	1✔
438	}
439
440	@Override
441	public String toString() {
442	return addrs.toString();	1✔
443	}
444	}
445
446	protected static class AcceptResolvedAddrRetVal {
447	public final Status status;
448	public final List<ChildLbState> removedChildren;
449
450	public AcceptResolvedAddrRetVal(Status status, List<ChildLbState> removedChildren) {	1✔
451	this.status = status;	1✔
452	this.removedChildren = removedChildren;	1✔
453	}	1✔
454	}
455	}

grpc / grpc-java / #19441

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