-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
xds: implement WeightedTargetLoadBalancer
- Loading branch information
1 parent
3b8e363
commit 5e7b8c6
Showing
9 changed files
with
959 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
193 changes: 193 additions & 0 deletions
193
xds/src/main/java/io/grpc/xds/WeightedTargetLoadBalancer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,193 @@ | ||
| /* | ||
| * Copyright 2020 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.xds; | ||
|
|
||
| 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.TRANSIENT_FAILURE; | ||
| import static io.grpc.xds.XdsSubchannelPickers.BUFFER_PICKER; | ||
|
|
||
| import com.google.common.collect.ImmutableMap; | ||
| import io.grpc.ConnectivityState; | ||
| import io.grpc.InternalLogId; | ||
| import io.grpc.LoadBalancer; | ||
| import io.grpc.Status; | ||
| import io.grpc.util.ForwardingLoadBalancerHelper; | ||
| import io.grpc.util.GracefulSwitchLoadBalancer; | ||
| import io.grpc.xds.WeightedRandomPicker.WeightedChildPicker; | ||
| import io.grpc.xds.WeightedTargetLoadBalancerProvider.WeightedPolicySelection; | ||
| import io.grpc.xds.WeightedTargetLoadBalancerProvider.WeightedTargetConfig; | ||
| import io.grpc.xds.XdsLogger.XdsLogLevel; | ||
| import io.grpc.xds.XdsSubchannelPickers.ErrorPicker; | ||
| import java.util.ArrayList; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** Load balancer for weighted_target policy. */ | ||
| final class WeightedTargetLoadBalancer extends LoadBalancer { | ||
|
|
||
| private final XdsLogger logger; | ||
| private final Map<String, GracefulSwitchLoadBalancer> childBalancers = new HashMap<>(); | ||
| private final Map<String, ChildHelper> childHelpers = new HashMap<>(); | ||
| private final Helper helper; | ||
|
|
||
| private Map<String, WeightedPolicySelection> targets = ImmutableMap.of(); | ||
|
|
||
| WeightedTargetLoadBalancer(Helper helper) { | ||
| this.helper = helper; | ||
| logger = XdsLogger.withLogId( | ||
| InternalLogId.allocate("weighted-target-lb", helper.getAuthority())); | ||
| logger.log(XdsLogLevel.INFO, "Created"); | ||
| } | ||
|
|
||
| @Override | ||
| public void handleResolvedAddresses(ResolvedAddresses resolvedAddresses) { | ||
| logger.log(XdsLogLevel.DEBUG, "Received resolution result: {0}", resolvedAddresses); | ||
| Object lbConfig = resolvedAddresses.getLoadBalancingPolicyConfig(); | ||
| checkNotNull(lbConfig, "missing weighted_target lb config"); | ||
|
|
||
| WeightedTargetConfig weightedTargetConfig = (WeightedTargetConfig) lbConfig; | ||
| Map<String, WeightedPolicySelection> newTargets = weightedTargetConfig.targets; | ||
|
|
||
| for (String targetName : newTargets.keySet()) { | ||
| WeightedPolicySelection weightedChildLbConfig = newTargets.get(targetName); | ||
| if (!targets.containsKey(targetName)) { | ||
| ChildHelper childHelper = new ChildHelper(); | ||
| GracefulSwitchLoadBalancer childBalancer = new GracefulSwitchLoadBalancer(childHelper); | ||
| childBalancer.switchTo(weightedChildLbConfig.policySelection.getProvider()); | ||
| childHelpers.put(targetName, childHelper); | ||
| childBalancers.put(targetName, childBalancer); | ||
| } else if (!weightedChildLbConfig.policySelection.getProvider().equals( | ||
| targets.get(targetName).policySelection.getProvider())) { | ||
| childBalancers.get(targetName) | ||
| .switchTo(weightedChildLbConfig.policySelection.getProvider()); | ||
| } | ||
| } | ||
|
|
||
| targets = newTargets; | ||
|
|
||
| for (String targetName : targets.keySet()) { | ||
| childBalancers.get(targetName).handleResolvedAddresses( | ||
| resolvedAddresses.toBuilder() | ||
| .setLoadBalancingPolicyConfig(targets.get(targetName).policySelection.getConfig()) | ||
| .build()); | ||
| } | ||
|
|
||
| // Cleanup removed targets. | ||
| // TODO(zdapeng): cache removed target for 15 minutes. | ||
| for (String targetName : childBalancers.keySet()) { | ||
| if (!targets.containsKey(targetName)) { | ||
| childBalancers.get(targetName).shutdown(); | ||
| } | ||
| } | ||
| childBalancers.keySet().retainAll(targets.keySet()); | ||
| childHelpers.keySet().retainAll(targets.keySet()); | ||
| } | ||
|
|
||
| @Override | ||
| public void handleNameResolutionError(Status error) { | ||
| logger.log(XdsLogLevel.WARNING, "Received name resolution error: {0}", error); | ||
| if (childBalancers.isEmpty()) { | ||
| helper.updateBalancingState(TRANSIENT_FAILURE, new ErrorPicker(error)); | ||
| } | ||
| for (LoadBalancer childBalancer : childBalancers.values()) { | ||
| childBalancer.handleNameResolutionError(error); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public boolean canHandleEmptyAddressListFromNameResolution() { | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| public void shutdown() { | ||
| logger.log(XdsLogLevel.INFO, "Shutdown"); | ||
| for (LoadBalancer childBalancer : childBalancers.values()) { | ||
| childBalancer.shutdown(); | ||
| } | ||
| } | ||
|
|
||
| private void updateOverallBalancingState() { | ||
| List<WeightedChildPicker> childPickers = new ArrayList<>(); | ||
|
|
||
| ConnectivityState overallState = null; | ||
| for (String name : targets.keySet()) { | ||
| ChildHelper childHelper = childHelpers.get(name); | ||
| ConnectivityState childState = childHelper.currentState; | ||
| overallState = aggregateState(overallState, childState); | ||
| if (READY == childState) { | ||
| int weight = targets.get(name).weight; | ||
| childPickers.add(new WeightedChildPicker(weight, childHelper.currentPicker)); | ||
| } | ||
| } | ||
|
|
||
| SubchannelPicker picker; | ||
| if (childPickers.isEmpty()) { | ||
| if (overallState == TRANSIENT_FAILURE) { | ||
| picker = new ErrorPicker(Status.UNAVAILABLE); // TODO: more details in status | ||
| } else { | ||
| picker = XdsSubchannelPickers.BUFFER_PICKER; | ||
| } | ||
| } else { | ||
| picker = new WeightedRandomPicker(childPickers); | ||
| } | ||
|
|
||
| if (overallState != null) { | ||
| helper.updateBalancingState(overallState, picker); | ||
| } | ||
| } | ||
|
|
||
| @Nullable | ||
| private 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; | ||
| } | ||
|
|
||
| private final class ChildHelper extends ForwardingLoadBalancerHelper { | ||
| ConnectivityState currentState = CONNECTING; | ||
| SubchannelPicker currentPicker = BUFFER_PICKER; | ||
|
|
||
| @Override | ||
| public void updateBalancingState(ConnectivityState newState, SubchannelPicker newPicker) { | ||
| currentState = newState; | ||
| currentPicker = newPicker; | ||
| updateOverallBalancingState(); | ||
| } | ||
|
|
||
| @Override | ||
| protected Helper delegate() { | ||
| return helper; | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.