org.apache.hadoop.hbase.master.assignment

Class RegionRemoteProcedureBase

java.lang.Object

org.apache.hadoop.hbase.procedure2.Procedure<MasterProcedureEnv>

org.apache.hadoop.hbase.master.assignment.RegionRemoteProcedureBase

All Implemented Interfaces:

Comparable<Procedure<MasterProcedureEnv>>, TableProcedureInterface, RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

Direct Known Subclasses:

CloseRegionProcedure, OpenRegionProcedure

@InterfaceAudience.Private
public abstract class RegionRemoteProcedureBase
extends Procedure<MasterProcedureEnv>
implements TableProcedureInterface, RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

The base class for the remote procedures used to open/close a region.

Notice that here we do not care about the result of the remote call, if the remote call is finished, either succeeded or not, we will always finish the procedure. The parent procedure should take care of the result and try to reschedule if the result is not good.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.procedure2.Procedure

Procedure.LockState

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.master.procedure.TableProcedureInterface

TableProcedureInterface.TableOperationType

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG
protected RegionInfo	region
private RetryCounter	retryCounter
private long	seqId
private org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionRemoteProcedureBaseState	state
protected ServerName	targetServer
private org.apache.hadoop.hbase.shaded.protobuf.generated.RegionServerStatusProtos.RegionStateTransition.TransitionCode	transitionCode

Fields inherited from class org.apache.hadoop.hbase.procedure2.Procedure

NO_PROC_ID, NO_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegionRemoteProcedureBase()
protected	RegionRemoteProcedureBase(TransitRegionStateProcedure parent, RegionInfo region, ServerName targetServer)

Method Summary

Modifier and Type	Method and Description
protected boolean	abort(MasterProcedureEnv env) The abort() call is asynchronous and each procedure must decide how to deal with it, if they want to be abortable.
protected void	afterReplay(MasterProcedureEnv env) Called when the procedure is ready to be added to the queue after the loading/replay operation.
protected abstract void	checkTransition(RegionStateNode regionNode, org.apache.hadoop.hbase.shaded.protobuf.generated.RegionServerStatusProtos.RegionStateTransition.TransitionCode transitionCode, long seqId)
protected void	deserializeStateData(ProcedureStateSerializer serializer) Called on store load to allow the user to decode the previously serialized state.
protected Procedure<MasterProcedureEnv>[]	execute(MasterProcedureEnv env) The main code of the procedure.
private TransitRegionStateProcedure	getParent(MasterProcedureEnv env)
String	getProcName()
private RegionStateNode	getRegionNode(MasterProcedureEnv env)
TableName	getTableName() Returns the name of the table the procedure is operating on
protected abstract RemoteProcedureDispatcher.RemoteOperation	newRemoteOperation()
private void	persistAndWake(MasterProcedureEnv env, RegionStateNode regionNode)
Optional<RemoteProcedureDispatcher.RemoteOperation>	remoteCallBuild(MasterProcedureEnv env, ServerName remote) For building the remote operation.
void	remoteCallFailed(MasterProcedureEnv env, ServerName remote, IOException exception) Called when the executeProcedure call is failed.
void	remoteOperationCompleted(MasterProcedureEnv env) Called when RS tells the remote procedure is succeeded through the reportProcedureDone method.
void	remoteOperationFailed(MasterProcedureEnv env, RemoteProcedureException error) Called when RS tells the remote procedure is failed through the reportProcedureDone method.
(package private) void	reportTransition(MasterProcedureEnv env, RegionStateNode regionNode, ServerName serverName, org.apache.hadoop.hbase.shaded.protobuf.generated.RegionServerStatusProtos.RegionStateTransition.TransitionCode transitionCode, long seqId)
protected abstract void	restoreSucceedState(AssignmentManager am, RegionStateNode regionNode, long seqId)
protected void	rollback(MasterProcedureEnv env) The code to undo what was done by the execute() code.
protected void	serializeStateData(ProcedureStateSerializer serializer) The user-level code of the procedure may have some state to persist (e.g.
(package private) void	serverCrashed(MasterProcedureEnv env, RegionStateNode regionNode, ServerName serverName)
protected boolean	setTimeoutFailure(MasterProcedureEnv env) Called by the ProcedureExecutor when the timeout set by setTimeout() is expired.
(package private) void	stateLoaded(AssignmentManager am, RegionStateNode regionNode)
boolean	storeInDispatchedQueue() Whether store this remote procedure in dispatched queue only OpenRegionProcedure and CloseRegionProcedure return false since they are not fully controlled by dispatcher
protected void	toStringClassDetails(StringBuilder builder) Extend the toString() information with the procedure details e.g.
private void	unattach(MasterProcedureEnv env)
protected abstract void	updateTransitionWithoutPersistingToMeta(MasterProcedureEnv env, RegionStateNode regionNode, org.apache.hadoop.hbase.shaded.protobuf.generated.RegionServerStatusProtos.RegionStateTransition.TransitionCode transitionCode, long seqId)
protected boolean	waitInitialized(MasterProcedureEnv env) The Procedure.doAcquireLock(Object, ProcedureStore) will be split into two steps, first, it will call us to determine whether we need to wait for initialization, second, it will call Procedure.acquireLock(Object) to actually handle the lock for this procedure.

Methods inherited from class org.apache.hadoop.hbase.procedure2.Procedure

acquireLock, addStackIndex, beforeReplay, bypass, compareTo, completionCleanup, doExecute, doRollback, elapsedTime, getChildrenLatch, getException, getLastUpdate, getNonceKey, getOwner, getParentProcId, getProcedureMetrics, getProcId, getProcIdHashCode, getResult, getRootProcedureId, getRootProcId, getStackIndexes, getState, getSubmittedTime, getTimeout, getTimeoutTimestamp, hasChildren, hasException, hasLock, hasOwner, hasParent, hasTimeout, haveSameParent, holdLock, incChildrenLatch, isBypass, isFailed, isFinished, isInitializing, isLockedWhenLoading, isRunnable, isSuccess, isWaiting, isYieldAfterExecutionStep, releaseLock, removeStackIndex, setAbortFailure, setChildrenLatch, setFailure, setFailure, setLastUpdate, setNonceKey, setOwner, setOwner, setParentProcId, setProcId, setResult, setRootProcId, setStackIndexes, setState, setSubmittedTime, setTimeout, shouldWaitClientAck, skipPersistence, toString, toStringClass, toStringDetails, toStringSimpleSB, toStringState, updateMetricsOnFinish, updateMetricsOnSubmit, updateTimestamp, wasExecuted

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.hadoop.hbase.master.procedure.TableProcedureInterface

getTableOperationType

Field Detail

LOG

private static final org.slf4j.Logger LOG

region

protected RegionInfo region

targetServer

protected ServerName targetServer

state

private org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionRemoteProcedureBaseState state

transitionCode

private org.apache.hadoop.hbase.shaded.protobuf.generated.RegionServerStatusProtos.RegionStateTransition.TransitionCode transitionCode

seqId

private long seqId

retryCounter

private RetryCounter retryCounter

Constructor Detail

RegionRemoteProcedureBase

protected RegionRemoteProcedureBase()

RegionRemoteProcedureBase

protected RegionRemoteProcedureBase(TransitRegionStateProcedure parent,
                                    RegionInfo region,
                                    ServerName targetServer)

Method Detail

remoteCallBuild

public Optional<RemoteProcedureDispatcher.RemoteOperation> remoteCallBuild(MasterProcedureEnv env,
                                                                           ServerName remote)

Description copied from interface: RemoteProcedureDispatcher.RemoteProcedure

For building the remote operation. May be empty if no need to send remote call. Usually, this means the RemoteProcedure has been finished already. This is possible, as we may have already sent the procedure to RS but then the rpc connection is broken so the executeProcedures call fails, but the RS does receive the procedure and execute it and then report back, before we retry again.

Specified by:

remoteCallBuild in interface RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

newRemoteOperation

protected abstract RemoteProcedureDispatcher.RemoteOperation newRemoteOperation()

remoteOperationCompleted

public void remoteOperationCompleted(MasterProcedureEnv env)

Description copied from interface: RemoteProcedureDispatcher.RemoteProcedure

Called when RS tells the remote procedure is succeeded through the reportProcedureDone method.

Specified by:

remoteOperationCompleted in interface RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

remoteOperationFailed

public void remoteOperationFailed(MasterProcedureEnv env,
                                  RemoteProcedureException error)

Description copied from interface: RemoteProcedureDispatcher.RemoteProcedure

Called when RS tells the remote procedure is failed through the reportProcedureDone method.

Specified by:

remoteOperationFailed in interface RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

getRegionNode

private RegionStateNode getRegionNode(MasterProcedureEnv env)

remoteCallFailed

public void remoteCallFailed(MasterProcedureEnv env,
                             ServerName remote,
                             IOException exception)

Description copied from interface: RemoteProcedureDispatcher.RemoteProcedure

Called when the executeProcedure call is failed.

Specified by:

remoteCallFailed in interface RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

getTableName

public TableName getTableName()

Description copied from interface: TableProcedureInterface

Returns the name of the table the procedure is operating on

Specified by:

getTableName in interface TableProcedureInterface

waitInitialized

protected boolean waitInitialized(MasterProcedureEnv env)

Description copied from class: Procedure

The Procedure.doAcquireLock(Object, ProcedureStore) will be split into two steps, first, it will call us to determine whether we need to wait for initialization, second, it will call Procedure.acquireLock(Object) to actually handle the lock for this procedure.

This is because that when master restarts, we need to restore the lock state for all the procedures to not break the semantic if Procedure.holdLock(Object) is true. But the ProcedureExecutor will be started before the master finish initialization(as it is part of the initialization!), so we need to split the code into two steps, and when restore, we just restore the lock part and ignore the waitInitialized part. Otherwise there will be dead lock.

Overrides:

waitInitialized in class Procedure<MasterProcedureEnv>

Returns:

true means we need to wait until the environment has been initialized, otherwise true.

rollback

protected void rollback(MasterProcedureEnv env)
                 throws IOException,
                        InterruptedException

Description copied from class: Procedure

The code to undo what was done by the execute() code. It is called when the procedure or one of the sub-procedures failed or an abort was requested. It should cleanup all the resources created by the execute() call. The implementation must be idempotent since rollback() may be called multiple time in case of machine failure in the middle of the execution.

Specified by:

rollback in class Procedure<MasterProcedureEnv>

Parameters:

env - the environment passed to the ProcedureExecutor

Throws:

IOException - temporary failure, the rollback will retry later

InterruptedException - the procedure will be added back to the queue and retried later

abort

protected boolean abort(MasterProcedureEnv env)

Description copied from class: Procedure

The abort() call is asynchronous and each procedure must decide how to deal with it, if they want to be abortable. The simplest implementation is to have an AtomicBoolean set in the abort() method and then the execute() will check if the abort flag is set or not. abort() may be called multiple times from the client, so the implementation must be idempotent.

NOTE: abort() is not like Thread.interrupt(). It is just a notification that allows the procedure implementor abort.

Specified by:

abort in class Procedure<MasterProcedureEnv>

checkTransition

protected abstract void checkTransition(RegionStateNode regionNode,
                                        org.apache.hadoop.hbase.shaded.protobuf.generated.RegionServerStatusProtos.RegionStateTransition.TransitionCode transitionCode,
                                        long seqId)
                                 throws UnexpectedStateException

Throws:

UnexpectedStateException

updateTransitionWithoutPersistingToMeta

protected abstract void updateTransitionWithoutPersistingToMeta(MasterProcedureEnv env,
                                                                RegionStateNode regionNode,
                                                                org.apache.hadoop.hbase.shaded.protobuf.generated.RegionServerStatusProtos.RegionStateTransition.TransitionCode transitionCode,
                                                                long seqId)
                                                         throws IOException

Throws:

IOException

persistAndWake

private void persistAndWake(MasterProcedureEnv env,
                            RegionStateNode regionNode)

reportTransition

void reportTransition(MasterProcedureEnv env,
                      RegionStateNode regionNode,
                      ServerName serverName,
                      org.apache.hadoop.hbase.shaded.protobuf.generated.RegionServerStatusProtos.RegionStateTransition.TransitionCode transitionCode,
                      long seqId)
               throws IOException

Throws:

IOException

serverCrashed

void serverCrashed(MasterProcedureEnv env,
                   RegionStateNode regionNode,
                   ServerName serverName)

restoreSucceedState

protected abstract void restoreSucceedState(AssignmentManager am,
                                            RegionStateNode regionNode,
                                            long seqId)
                                     throws IOException

Throws:

IOException

stateLoaded

void stateLoaded(AssignmentManager am,
                 RegionStateNode regionNode)

getParent

private TransitRegionStateProcedure getParent(MasterProcedureEnv env)

unattach

private void unattach(MasterProcedureEnv env)

execute

protected Procedure<MasterProcedureEnv>[] execute(MasterProcedureEnv env)
                                           throws ProcedureYieldException,
                                                  ProcedureSuspendedException,
                                                  InterruptedException

Description copied from class: Procedure

The main code of the procedure. It must be idempotent since execute() may be called multiple times in case of machine failure in the middle of the execution.

Specified by:

execute in class Procedure<MasterProcedureEnv>

Parameters:

env - the environment passed to the ProcedureExecutor

Returns:

a set of sub-procedures to run or ourselves if there is more work to do or null if the procedure is done.

Throws:

ProcedureYieldException - the procedure will be added back to the queue and retried later.

ProcedureSuspendedException - Signal to the executor that Procedure has suspended itself and has set itself up waiting for an external event to wake it back up again.

InterruptedException - the procedure will be added back to the queue and retried later.

setTimeoutFailure

protected boolean setTimeoutFailure(MasterProcedureEnv env)

Description copied from class: Procedure

Called by the ProcedureExecutor when the timeout set by setTimeout() is expired.

Another usage for this method is to implement retrying. A procedure can set the state to WAITING_TIMEOUT by calling setState method, and throw a ProcedureSuspendedException to halt the execution of the procedure, and do not forget a call Procedure.setTimeout(int) method to set the timeout. And you should also override this method to wake up the procedure, and also return false to tell the ProcedureExecutor that the timeout event has been handled.

Overrides:

setTimeoutFailure in class Procedure<MasterProcedureEnv>

Returns:

true to let the framework handle the timeout as abort, false in case the procedure handled the timeout itself.

storeInDispatchedQueue

public boolean storeInDispatchedQueue()

Description copied from interface: RemoteProcedureDispatcher.RemoteProcedure

Whether store this remote procedure in dispatched queue only OpenRegionProcedure and CloseRegionProcedure return false since they are not fully controlled by dispatcher

Specified by:

storeInDispatchedQueue in interface RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

serializeStateData

protected void serializeStateData(ProcedureStateSerializer serializer)
                           throws IOException

Description copied from class: Procedure

The user-level code of the procedure may have some state to persist (e.g. input arguments or current position in the processing state) to be able to resume on failure.

Specified by:

serializeStateData in class Procedure<MasterProcedureEnv>

Parameters:

serializer - stores the serializable state

Throws:

IOException

deserializeStateData

protected void deserializeStateData(ProcedureStateSerializer serializer)
                             throws IOException

Description copied from class: Procedure

Called on store load to allow the user to decode the previously serialized state.

Specified by:

deserializeStateData in class Procedure<MasterProcedureEnv>

Parameters:

serializer - contains the serialized state

Throws:

IOException

afterReplay

protected void afterReplay(MasterProcedureEnv env)

Description copied from class: Procedure

Called when the procedure is ready to be added to the queue after the loading/replay operation.

Overrides:

afterReplay in class Procedure<MasterProcedureEnv>

getProcName

public String getProcName()

Overrides:

getProcName in class Procedure<MasterProcedureEnv>

toStringClassDetails

protected void toStringClassDetails(StringBuilder builder)

Description copied from class: Procedure

Extend the toString() information with the procedure details e.g. className and parameters

Overrides:

toStringClassDetails in class Procedure<MasterProcedureEnv>

Parameters:

builder - the string builder to use to append the proc specific information