org.infinispan.statetransfer.InboundTransferTask Maven / Gradle / Ivy
package org.infinispan.statetransfer;
import org.infinispan.commands.CommandsFactory;
import org.infinispan.commons.CacheException;
import org.infinispan.remoting.responses.ExceptionResponse;
import org.infinispan.remoting.responses.Response;
import org.infinispan.remoting.responses.SuccessfulResponse;
import org.infinispan.remoting.rpc.ResponseMode;
import org.infinispan.remoting.rpc.RpcManager;
import org.infinispan.remoting.rpc.RpcOptions;
import org.infinispan.remoting.transport.Address;
import org.infinispan.util.logging.Log;
import org.infinispan.util.logging.LogFactory;
import java.util.Collections;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
/**
* Inbound state transfer task. Fetches multiple data segments from a remote source node and applies them to local
* cache. Instances of InboundTransferTask are created and managed by StateTransferManagerImpl. StateTransferManagerImpl
* must have zero or one such task for each segment.
*
* @author [email protected]
* @since 5.2
*/
public class InboundTransferTask {
private static final Log log = LogFactory.getLog(InboundTransferTask.class);
private static final boolean trace = log.isTraceEnabled();
/**
* All access to fields {@code segments} and {@code finishedSegments} must bead done while synchronizing on {@code segments}.
*/
private final Set segments = new HashSet<>();
/**
* All access to fields {@code segments} and {@code finishedSegments} must bead done while synchronizing on {@code segments}.
*/
private final Set finishedSegments = new HashSet<>();
private final Address source;
private volatile boolean isCancelled = false;
/**
* Indicates if the request was sent to source.
*/
private final AtomicBoolean isStarted = new AtomicBoolean();
/**
* Indicates if the START_STATE_TRANSFER was successfully sent to source node and the source replied with a successful response.
*/
private boolean isStartedSuccessfully = false;
/**
* Indicates if the task was completed normally: all requested segments were completely received except for the cancelled ones.
* This flag is only meaningful when completionLatch becomes 0.
*/
private volatile boolean isCompletedSuccessfully = false;
/**
* This latch is counted down when all segments are completely received or in case of task cancellation.
*/
private final CountDownLatch completionLatch = new CountDownLatch(1);
private final StateConsumerImpl stateConsumer;
private final int topologyId;
private final RpcManager rpcManager;
private final CommandsFactory commandsFactory;
private final long timeout;
private final String cacheName;
private final RpcOptions rpcOptions;
public InboundTransferTask(Set segments, Address source, int topologyId, StateConsumerImpl stateConsumer, RpcManager rpcManager, CommandsFactory commandsFactory, long timeout, String cacheName) {
if (segments == null || segments.isEmpty()) {
throw new IllegalArgumentException("segments must not be null or empty");
}
if (source == null) {
throw new IllegalArgumentException("Source address cannot be null");
}
this.segments.addAll(segments);
this.source = source;
this.topologyId = topologyId;
this.stateConsumer = stateConsumer;
this.rpcManager = rpcManager;
this.commandsFactory = commandsFactory;
this.timeout = timeout;
this.cacheName = cacheName;
//the rpc options does not changed in runtime and they are the same in all the remote invocations. re-use the
//same instance
this.rpcOptions = rpcManager.getRpcOptionsBuilder(ResponseMode.SYNCHRONOUS_IGNORE_LEAVERS)
.timeout(timeout, TimeUnit.MILLISECONDS).build();
}
public Set getSegments() {
synchronized (segments) {
return new HashSet<>(segments);
}
}
public Set getUnfinishedSegments() {
synchronized (segments) {
Set unfinishedSegments = new HashSet<>(segments);
unfinishedSegments.removeAll(finishedSegments);
return unfinishedSegments;
}
}
public Address getSource() {
return source;
}
/**
* Send START_STATE_TRANSFER request to source node.
*
* @return {@code true} if the transfer was started, otherwise {@code false}
*/
public boolean requestSegments() {
if (!isCancelled && isStarted.compareAndSet(false, true)) {
Set segmentsCopy = getSegments();
if (segmentsCopy.isEmpty()) {
log.tracef("Segments list is empty, skipping source %s", source);
return false;
}
if (trace) {
log.tracef("Requesting segments %s of cache %s from node %s", segmentsCopy, cacheName, source);
}
// start transfer of cache entries
try {
StateRequestCommand cmd = commandsFactory.buildStateRequestCommand(StateRequestCommand.Type.START_STATE_TRANSFER, rpcManager.getAddress(), topologyId, segmentsCopy);
Map responses = rpcManager.invokeRemotely(Collections.singleton(source), cmd, rpcOptions);
Response response = responses.get(source);
if (response instanceof SuccessfulResponse) {
isStartedSuccessfully = true;
if (trace) {
log.tracef("Successfully requested segments %s of cache %s from node %s", segmentsCopy, cacheName, source);
}
} else {
Exception e = response instanceof ExceptionResponse ?
((ExceptionResponse) response).getException() : new CacheException(String.valueOf(response));
log.failedToRequestSegments(segmentsCopy, cacheName, source, e);
}
} catch (Exception e) {
log.failedToRequestSegments(segmentsCopy, cacheName, source, e);
}
}
return isStartedSuccessfully;
}
/**
* Cancels a subset of the segments. If it happens that all segments are cancelled then the whole task is marked as cancelled and completion is signalled..
*
* @param cancelledSegments the segments to be cancelled
*/
public void cancelSegments(Set cancelledSegments) {
if (isCancelled) {
throw new IllegalArgumentException("The task is already cancelled.");
}
if (trace) {
log.tracef("Cancelling inbound state transfer of segments %s of cache %s", cancelledSegments, cacheName);
}
synchronized (segments) {
// healthy paranoia
if (!segments.containsAll(cancelledSegments)) {
throw new IllegalArgumentException("Some of the specified segments cannot be cancelled because they were not previously requested");
}
segments.removeAll(cancelledSegments);
finishedSegments.removeAll(cancelledSegments);
if (segments.isEmpty()) {
isCancelled = true;
}
}
sendCancelCommand(cancelledSegments);
if (isCancelled) {
notifyCompletion(false);
}
}
public void cancel() {
if (!isCancelled) {
isCancelled = true;
Set segmentsCopy = getSegments();
if (trace) {
log.tracef("Cancelling inbound state transfer of segments %s of cache %s", segmentsCopy, cacheName);
}
sendCancelCommand(segmentsCopy);
notifyCompletion(false);
}
}
public boolean isCancelled() {
return isCancelled;
}
private void sendCancelCommand(Set cancelledSegments) {
StateRequestCommand cmd = commandsFactory.buildStateRequestCommand(
StateRequestCommand.Type.CANCEL_STATE_TRANSFER, rpcManager.getAddress(), topologyId,
cancelledSegments);
try {
rpcManager.invokeRemotely(Collections.singleton(source), cmd, rpcManager.getDefaultRpcOptions(false));
} catch (Exception e) {
// Ignore exceptions here, the worst that can happen is that the provider will send some extra state
log.debugf("Caught an exception while cancelling state transfer for segments %s from %s",
cancelledSegments, source);
}
}
public void onStateReceived(int segmentId, boolean isLastChunk) {
if (!isCancelled && isLastChunk) {
boolean isCompleted = false;
synchronized (segments) {
if (segments.contains(segmentId)) {
finishedSegments.add(segmentId);
if (finishedSegments.size() == segments.size()) {
log.debugf("Finished receiving state for segments %s of cache %s", segments, cacheName);
isCompleted = true;
}
}
}
if (isCompleted) {
notifyCompletion(true);
}
}
}
private void notifyCompletion(boolean success) {
isCompletedSuccessfully = success;
completionLatch.countDown();
stateConsumer.onTaskCompletion(this);
}
/**
* Wait until all segments are received, cancelled, or the task is terminated abruptly by terminate().
*
* @return true if the task completed normally or false if it was terminated abruptly
* @throws InterruptedException if the thread is interrupted while waiting
*/
public boolean awaitCompletion() throws InterruptedException {
if (!isStartedSuccessfully) {
throw new IllegalStateException("Cannot await completion unless the request was previously sent to source node successfully.");
}
completionLatch.await();
return isCompletedSuccessfully;
}
public boolean isCompletedSuccessfully() {
return isCompletedSuccessfully;
}
public boolean isStartedSuccessfully() {
return isStartedSuccessfully;
}
/**
* Terminate abruptly regardless if the segments were received or not. This is used when the source node
* is no longer alive.
*/
public void terminate() {
notifyCompletion(false);
}
@Override
public String toString() {
synchronized (segments) {
return "InboundTransferTask{" +
"segments=" + segments +
", finishedSegments=" + finishedSegments +
", unfinishedSegments=" + getUnfinishedSegments() +
", source=" + source +
", isCancelled=" + isCancelled +
", isStartedSuccessfully=" + isStartedSuccessfully +
", isCompletedSuccessfully=" + isCompletedSuccessfully +
", topologyId=" + topologyId +
", timeout=" + timeout +
", cacheName=" + cacheName +
'}';
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy