org.apache.geode.internal.cache.execute.MultiRegionFunctionExecutor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of geode-core Show documentation
Show all versions of geode-core Show documentation
Apache Geode provides a database-like consistency model, reliable transaction processing and a shared-nothing architecture to maintain very low latency performance with high concurrency processing
/*
* Licensed to the Apache Software Foundation (ASF) under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional information regarding
* copyright ownership. The ASF licenses this file to You 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 org.apache.geode.internal.cache.execute;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Random;
import java.util.Set;
import org.apache.geode.cache.Cache;
import org.apache.geode.cache.DataPolicy;
import org.apache.geode.cache.LowMemoryException;
import org.apache.geode.cache.Region;
import org.apache.geode.cache.TransactionDataNotColocatedException;
import org.apache.geode.cache.TransactionException;
import org.apache.geode.cache.execute.Execution;
import org.apache.geode.cache.execute.Function;
import org.apache.geode.cache.execute.FunctionException;
import org.apache.geode.cache.execute.ResultCollector;
import org.apache.geode.distributed.DistributedMember;
import org.apache.geode.distributed.internal.DM;
import org.apache.geode.distributed.internal.InternalDistributedSystem;
import org.apache.geode.distributed.internal.membership.InternalDistributedMember;
import org.apache.geode.internal.Assert;
import org.apache.geode.internal.SetUtils;
import org.apache.geode.internal.cache.DistributedRegion;
import org.apache.geode.internal.cache.GemFireCacheImpl;
import org.apache.geode.internal.cache.LocalRegion;
import org.apache.geode.internal.cache.PartitionedRegion;
import org.apache.geode.internal.cache.control.MemoryThresholds;
import org.apache.geode.internal.i18n.LocalizedStrings;
/**
*
*
*/
public class MultiRegionFunctionExecutor extends AbstractExecution {
private final Set regions;
private ServerToClientFunctionResultSender sender;
public MultiRegionFunctionExecutor(Set regions) {
this.regions = regions;
}
private MultiRegionFunctionExecutor(MultiRegionFunctionExecutor drfe) {
super(drfe);
this.regions = drfe.regions;
if (drfe.filter != null) {
this.filter.clear();
this.filter.addAll(drfe.filter);
}
this.sender = drfe.sender;
}
private MultiRegionFunctionExecutor(Set regions, Set filter2, Object args,
MemberMappedArgument memberMappedArg, ServerToClientFunctionResultSender resultSender) {
if (args != null) {
this.args = args;
} else if (memberMappedArg != null) {
this.memberMappedArg = memberMappedArg;
this.isMemberMappedArgument = true;
}
this.sender = resultSender;
if (filter2 != null) {
this.filter.clear();
this.filter.addAll(filter2);
}
this.regions = regions;
this.isClientServerMode = true;
}
private MultiRegionFunctionExecutor(MultiRegionFunctionExecutor executor,
MemberMappedArgument argument) {
super(executor);
this.regions = executor.getRegions();
this.filter.clear();
this.filter.addAll(executor.filter);
this.sender = executor.getServerResultSender();
this.memberMappedArg = argument;
this.isMemberMappedArgument = true;
}
private MultiRegionFunctionExecutor(MultiRegionFunctionExecutor executor, ResultCollector rs) {
super(executor);
this.regions = executor.getRegions();
this.filter.clear();
this.filter.addAll(executor.filter);
this.sender = executor.getServerResultSender();
this.rc = rs;
}
public MultiRegionFunctionExecutor(MultiRegionFunctionExecutor executor, Object args) {
super(executor);
this.regions = executor.getRegions();
this.filter.clear();
this.filter.addAll(executor.filter);
this.sender = executor.getServerResultSender();
this.args = args;
}
public MultiRegionFunctionExecutor(MultiRegionFunctionExecutor executor, boolean isReExecute) {
super(executor);
this.regions = executor.getRegions();
this.filter.clear();
this.filter.addAll(executor.filter);
this.sender = executor.getServerResultSender();
this.isReExecute = isReExecute;
}
public InternalExecution withMemberMappedArgument(MemberMappedArgument argument) {
if (argument == null) {
throw new IllegalArgumentException(
LocalizedStrings.ExecuteRegionFunction_THE_INPUT_0_FOR_THE_EXECUTE_FUNCTION_REQUEST_IS_NULL
.toLocalizedString("MemberMapped Arg"));
}
return new MultiRegionFunctionExecutor(this, argument);
}
public Set getRegions() {
return this.regions;
}
public ServerToClientFunctionResultSender getServerResultSender() {
return this.sender;
}
public Execution withArgs(Object args) {
if (args == null) {
throw new IllegalArgumentException(
LocalizedStrings.ExecuteRegionFunction_THE_INPUT_0_FOR_THE_EXECUTE_FUNCTION_REQUEST_IS_NULL
.toLocalizedString("args"));
}
return new MultiRegionFunctionExecutor(this, args);
}
public Execution withCollector(ResultCollector rc) {
if (rc == null) {
throw new IllegalArgumentException(
LocalizedStrings.ExecuteRegionFunction_THE_INPUT_0_FOR_THE_EXECUTE_FUNCTION_REQUEST_IS_NULL
.toLocalizedString("Result Collector"));
}
return new MultiRegionFunctionExecutor(this, rc);
}
public Execution withFilter(Set filter) {
throw new FunctionException(
LocalizedStrings.ExecuteFunction_CANNOT_SPECIFY_0_FOR_ONREGIONS_FUNCTION
.toLocalizedString("filter"));
}
@Override
public InternalExecution withBucketFilter(Set bucketIDs) {
throw new FunctionException(
LocalizedStrings.ExecuteFunction_CANNOT_SPECIFY_0_FOR_ONREGIONS_FUNCTION
.toLocalizedString("bucket as filter"));
}
@Override
protected ResultCollector executeFunction(Function function) {
if (function.hasResult()) {
ResultCollector rc = this.rc;
if (rc == null) {
rc = new DefaultResultCollector();
}
return executeFunction(function, rc);
} else {
executeFunction(function, null);
return new NoResult();
}
}
private ResultCollector executeFunction(final Function function,
ResultCollector resultCollector) {
InternalDistributedSystem ds = InternalDistributedSystem.getConnectedInstance();
if (ds == null) {
throw new IllegalStateException(
LocalizedStrings.ExecuteFunction_DS_NOT_CREATED_OR_NOT_READY.toLocalizedString());
}
final DM dm = ds.getDistributionManager();
final Map> memberToRegionMap =
calculateMemberToRegionMap();
final Set dest =
new HashSet(memberToRegionMap.keySet());
if (dest.isEmpty()) {
throw new FunctionException(
LocalizedStrings.MemberFunctionExecutor_NO_MEMBER_FOUND_FOR_EXECUTING_FUNCTION_0
.toLocalizedString(function.getId()));
}
final GemFireCacheImpl cache = GemFireCacheImpl.getInstance();
if (function.optimizeForWrite() && cache != null
&& cache.getResourceManager().getHeapMonitor().containsHeapCriticalMembers(dest)
&& !MemoryThresholds.isLowMemoryExceptionDisabled()) {
Set hcm = cache.getResourceAdvisor().adviseCritialMembers();
Set sm = SetUtils.intersection(hcm, dest);
throw new LowMemoryException(
LocalizedStrings.ResourceManager_LOW_MEMORY_FOR_0_FUNCEXEC_MEMBERS_1
.toLocalizedString(new Object[] {function.getId(), sm}),
sm);
}
setExecutionNodes(dest);
final InternalDistributedMember localVM = cache.getMyId();
final LocalResultCollector localResultCollector =
getLocalResultCollector(function, resultCollector);
boolean remoteOnly = false;
boolean localOnly = false;
if (!dest.contains(localVM)) {
remoteOnly = true;
}
if (dest.size() == 1 && dest.contains(localVM)) {
localOnly = true;
}
validateExecution(function, dest);
final MemberFunctionResultSender resultSender = new MemberFunctionResultSender(dm,
localResultCollector, function, localOnly, remoteOnly, null);
if (dest.contains(localVM)) {
// if member is local VM
dest.remove(localVM);
Set regionPathSet = memberToRegionMap.get(localVM);
Set regions = new HashSet();
if (regionPathSet != null) {
Cache cache1 = GemFireCacheImpl.getInstance();
for (String regionPath : regionPathSet) {
regions.add(cache1.getRegion(regionPath));
}
}
final FunctionContextImpl context = new MultiRegionFunctionContextImpl(function.getId(),
getArgumentsForMember(localVM.getId()), resultSender, regions, this.isReExecute);
boolean isTx = cache.getTxManager().getTXState() == null ? false : true;
executeFunctionOnLocalNode(function, context, resultSender, dm, isTx);
}
if (!dest.isEmpty()) {
HashMap memberArgs =
new HashMap();
for (InternalDistributedMember recip : dest) {
memberArgs.put(recip, getArgumentsForMember(recip.getId()));
}
Assert.assertTrue(memberArgs.size() == dest.size());
MultiRegionFunctionResultWaiter waiter = new MultiRegionFunctionResultWaiter(ds,
localResultCollector, function, dest, memberArgs, resultSender, memberToRegionMap);
ResultCollector reply = waiter.getFunctionResultFrom(dest, function, this);
return reply;
}
return localResultCollector;
}
private Map> calculateMemberToRegionMap() {
Map> memberToRegions =
new HashMap>();
// nodes is maintained for node pruning logic
Set nodes = new HashSet();
for (Region region : regions) {
DataPolicy dp = region.getAttributes().getDataPolicy();
if (region instanceof PartitionedRegion) {
PartitionedRegion pr = (PartitionedRegion) region;
Set prMembers = pr.getRegionAdvisor().advisePrimaryOwners();
if (pr.isDataStore()) {
GemFireCacheImpl cache = (GemFireCacheImpl) region.getCache();
// Add local node
InternalDistributedMember localVm = cache.getMyId();
Set regions = memberToRegions.get(localVm);
if (regions == null) {
regions = new HashSet();
}
regions.add(pr.getFullPath());
memberToRegions.put(localVm, regions);
}
if (prMembers != null) {
for (InternalDistributedMember member : prMembers) {
Set regions = memberToRegions.get(member);
if (regions == null) {
regions = new HashSet();
}
regions.add(pr.getFullPath());
memberToRegions.put(member, regions);
}
nodes.addAll(prMembers);
}
} else if (region instanceof DistributedRegion) {
if (dp.isEmpty() || dp.isNormal()) {
// Add local members
DistributedRegion dr = (DistributedRegion) region;
Set replicates =
dr.getCacheDistributionAdvisor().adviseInitializedReplicates();
// if existing nodes contain one of the nodes from replicates
boolean added = false;
for (InternalDistributedMember member : replicates) {
if (nodes.contains(member)) {
added = true;
Set regions = memberToRegions.get(member);
if (regions == null) {
regions = new HashSet();
}
regions.add(dr.getFullPath());
memberToRegions.put(member, regions);
break;
}
}
// if existing nodes set is mutually exclusive to replicates
if (replicates.size() != 0 && !added) {
// select a random replicate
InternalDistributedMember member = (InternalDistributedMember) (replicates
.toArray()[new Random().nextInt(replicates.size())]);
Set regions = memberToRegions.get(member);
if (regions == null) {
regions = new HashSet();
}
regions.add(dr.getFullPath());
memberToRegions.put(member, regions);
}
} else if (dp.withReplication()) {
GemFireCacheImpl cache = (GemFireCacheImpl) region.getCache();
// Add local node
InternalDistributedMember local = cache.getMyId();
Set regions = memberToRegions.get(local);
if (regions == null) {
regions = new HashSet();
}
regions.add(region.getFullPath());
memberToRegions.put(local, regions);
}
} else if (region instanceof LocalRegion) {
GemFireCacheImpl cache = (GemFireCacheImpl) region.getCache();
// Add local node
InternalDistributedMember local = cache.getMyId();
Set regions = memberToRegions.get(local);
if (regions == null) {
regions = new HashSet();
}
regions.add(region.getFullPath());
memberToRegions.put(local, regions);
}
}
return memberToRegions;
}
@Override
public AbstractExecution setIsReExecute() {
return new MultiRegionFunctionExecutor(this, true);
}
@Override
public void validateExecution(Function function, Set targetMembers) {
GemFireCacheImpl cache = null;
for (Region r : regions) {
cache = (GemFireCacheImpl) r.getCache();
break;
}
if (cache != null && cache.getTxManager().getTXState() != null) {
if (targetMembers.size() > 1) {
throw new TransactionException(
LocalizedStrings.PartitionedRegion_TX_FUNCTION_ON_MORE_THAN_ONE_NODE
.toLocalizedString());
} else {
assert targetMembers.size() == 1;
DistributedMember funcTarget = (DistributedMember) targetMembers.iterator().next();
DistributedMember target = cache.getTxManager().getTXState().getTarget();
if (target == null) {
cache.getTxManager().getTXState().setTarget(funcTarget);
} else if (!target.equals(funcTarget)) {
throw new TransactionDataNotColocatedException(
LocalizedStrings.PartitionedRegion_TX_FUNCTION_EXECUTION_NOT_COLOCATED_0_1
.toLocalizedString(new Object[] {target, funcTarget}));
}
}
}
if (function.optimizeForWrite()
&& cache.getResourceManager().getHeapMonitor().containsHeapCriticalMembers(targetMembers)
&& !MemoryThresholds.isLowMemoryExceptionDisabled()) {
Set hcm = cache.getResourceAdvisor().adviseCritialMembers();
Set sm = SetUtils.intersection(hcm, targetMembers);
throw new LowMemoryException(
LocalizedStrings.ResourceManager_LOW_MEMORY_FOR_0_FUNCEXEC_MEMBERS_1
.toLocalizedString(new Object[] {function.getId(), sm}),
sm);
}
}
}