org.apache.hadoop.hbase.master.assignment

Class TransitRegionStateProcedure

java.lang.Object

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

org.apache.hadoop.hbase.procedure2.StateMachineProcedure<MasterProcedureEnv,TState>

org.apache.hadoop.hbase.master.procedure.AbstractStateMachineTableProcedure<TState>

org.apache.hadoop.hbase.master.procedure.AbstractStateMachineRegionProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState>

org.apache.hadoop.hbase.master.assignment.TransitRegionStateProcedure

All Implemented Interfaces:

Comparable<Procedure<MasterProcedureEnv>>, TableProcedureInterface

@InterfaceAudience.Private
public class TransitRegionStateProcedure
extends AbstractStateMachineRegionProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState>

The procedure to deal with the state transition of a region. A region with a TRSP in place is called RIT, i.e, RegionInTransition.

It can be used to assign/unassign/reopen/move a region, and for unassign(MasterProcedureEnv, RegionInfo) and reopen(MasterProcedureEnv, RegionInfo), you do not need to specify a target server, and for assign(MasterProcedureEnv, RegionInfo, ServerName) and move(MasterProcedureEnv, RegionInfo, ServerName), if you want to you can provide a target server. And for move(MasterProcedureEnv, RegionInfo, ServerName), if you do not specify a targetServer, we will select one randomly.

The typical state transition for assigning a region is:

 GET_ASSIGN_CANDIDATE ------> OPEN -----> CONFIRM_OPENED
 

Notice that, if there are failures we may go back to the GET_ASSIGN_CANDIDATE state to try again.

The typical state transition for unassigning a region is:

 CLOSE -----> CONFIRM_CLOSED
 

Here things go a bit different, if there are failures, especially that if there is a server crash, we will go to the GET_ASSIGN_CANDIDATE state to bring the region online first, and then go through the normal way to unassign it.

The typical state transition for reopening/moving a region is:

 CLOSE -----> CONFIRM_CLOSED -----> GET_ASSIGN_CANDIDATE ------> OPEN -----> CONFIRM_OPENED
 

The retry logic is the same with the above assign/unassign.

Notice that, although we allow specify a target server, it just acts as a candidate, we do not guarantee that the region will finally be on the target server. If this is important for you, you should check whether the region is on the target server after the procedure is finished.

When you want to schedule a TRSP, please check whether there is still one for this region, and the check should be under the RegionStateNode lock. We will remove the TRSP from a RegionStateNode when we are done, see the code in reportTransition method below. There could be at most one TRSP for a give region.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransitRegionStateProcedure.TransitionType

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

StateMachineProcedure.Flow

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 inherited from class org.apache.hadoop.hbase.procedure2.Procedure

NO_PROC_ID, NO_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor and Description
	TransitRegionStateProcedure()
protected	TransitRegionStateProcedure(MasterProcedureEnv env, RegionInfo hri, ServerName assignCandidate, boolean forceNewPlan, TransitRegionStateProcedure.TransitionType type)

Method Summary

Modifier and Type	Method and Description
static TransitRegionStateProcedure	assign(MasterProcedureEnv env, RegionInfo region, boolean forceNewPlan, ServerName targetServer)
static TransitRegionStateProcedure	assign(MasterProcedureEnv env, RegionInfo region, ServerName targetServer)
protected void	deserializeStateData(ProcedureStateSerializer serializer)
protected Procedure[]	execute(MasterProcedureEnv env)
protected StateMachineProcedure.Flow	executeFromState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState state)
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState	getInitialState()
protected ProcedureMetrics	getProcedureMetrics(MasterProcedureEnv env)
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState	getState(int stateId)
protected int	getStateId(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState state)
TableProcedureInterface.TableOperationType	getTableOperationType() Given an operation type we can take decisions about what to do with pending operations.
static TransitRegionStateProcedure	move(MasterProcedureEnv env, RegionInfo region, ServerName targetServer)
static TransitRegionStateProcedure	reopen(MasterProcedureEnv env, RegionInfo region)
void	reportTransition(MasterProcedureEnv env, RegionStateNode regionNode, ServerName serverName, org.apache.hadoop.hbase.shaded.protobuf.generated.RegionServerStatusProtos.RegionStateTransition.TransitionCode code, long seqId, long procId)
protected void	rollbackState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState state)
protected void	serializeStateData(ProcedureStateSerializer serializer)
void	serverCrashed(MasterProcedureEnv env, RegionStateNode regionNode, ServerName serverName)
protected boolean	setTimeoutFailure(MasterProcedureEnv env) At end of timeout, wake ourselves up so we run again.
void	toStringClassDetails(StringBuilder sb)
static TransitRegionStateProcedure	unassign(MasterProcedureEnv env, RegionInfo region)
protected boolean	waitInitialized(MasterProcedureEnv env)

Methods inherited from class org.apache.hadoop.hbase.master.procedure.AbstractStateMachineRegionProcedure

acquireLock, checkTableModifiable, getRegion, getTableName, holdLock, releaseLock, setFailure, setRegion

Methods inherited from class org.apache.hadoop.hbase.master.procedure.AbstractStateMachineTableProcedure

checkOnline, getUser, getWALRegionDir, preflightChecks, releaseSyncLatch, setUser

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

abort, addChildProcedure, failIfAborted, getCurrentState, getCurrentStateId, getCycles, isRollbackSupported, isYieldAfterExecutionStep, isYieldBeforeExecuteFromState, rollback, setNextState, toStringState

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TransitRegionStateProcedure

public TransitRegionStateProcedure()

TransitRegionStateProcedure

protected TransitRegionStateProcedure(MasterProcedureEnv env,
                                      RegionInfo hri,
                                      ServerName assignCandidate,
                                      boolean forceNewPlan,
                                      TransitRegionStateProcedure.TransitionType type)

Method Detail

getTableOperationType

public TableProcedureInterface.TableOperationType getTableOperationType()

Description copied from interface: TableProcedureInterface

Given an operation type we can take decisions about what to do with pending operations. e.g. if we get a delete and we have some table operation pending (e.g. add column) we can abort those operations.

Specified by:

getTableOperationType in interface TableProcedureInterface

Specified by:

getTableOperationType in class AbstractStateMachineRegionProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState>

Returns:

the operation type that the procedure is executing.

waitInitialized

protected boolean waitInitialized(MasterProcedureEnv env)

Overrides:

waitInitialized in class AbstractStateMachineTableProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState>

execute

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

Overrides:

execute in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState>

Throws:

ProcedureSuspendedException

ProcedureYieldException

InterruptedException

executeFromState

protected StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env,
                                                      org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState state)
                                               throws ProcedureSuspendedException,
                                                      ProcedureYieldException,
                                                      InterruptedException

Specified by:

executeFromState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState>

Throws:

ProcedureSuspendedException

ProcedureYieldException

InterruptedException

setTimeoutFailure

protected boolean setTimeoutFailure(MasterProcedureEnv env)

At end of timeout, wake ourselves up so we run again.

Overrides:

setTimeoutFailure in class Procedure<MasterProcedureEnv>

reportTransition

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

Throws:

IOException

serverCrashed

public void serverCrashed(MasterProcedureEnv env,
                          RegionStateNode regionNode,
                          ServerName serverName)
                   throws IOException

Throws:

IOException

rollbackState

protected void rollbackState(MasterProcedureEnv env,
                             org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState state)
                      throws IOException,
                             InterruptedException

Specified by:

rollbackState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState>

Throws:

IOException

InterruptedException

getState

protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState getState(int stateId)

Specified by:

getState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState>

getStateId

protected int getStateId(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState state)

Specified by:

getStateId in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState>

getInitialState

protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState getInitialState()

Specified by:

getInitialState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState>

serializeStateData

protected void serializeStateData(ProcedureStateSerializer serializer)
                           throws IOException

Overrides:

serializeStateData in class AbstractStateMachineRegionProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState>

Throws:

IOException

deserializeStateData

protected void deserializeStateData(ProcedureStateSerializer serializer)
                             throws IOException

Overrides:

deserializeStateData in class AbstractStateMachineRegionProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState>

Throws:

IOException

getProcedureMetrics

protected ProcedureMetrics getProcedureMetrics(MasterProcedureEnv env)

Overrides:

getProcedureMetrics in class Procedure<MasterProcedureEnv>

toStringClassDetails

public void toStringClassDetails(StringBuilder sb)

Overrides:

toStringClassDetails in class AbstractStateMachineRegionProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionStateTransitionState>

assign

public static TransitRegionStateProcedure assign(MasterProcedureEnv env,
                                                 RegionInfo region,
                                                 @Nullable
                                                 ServerName targetServer)

assign

public static TransitRegionStateProcedure assign(MasterProcedureEnv env,
                                                 RegionInfo region,
                                                 boolean forceNewPlan,
                                                 @Nullable
                                                 ServerName targetServer)

unassign

public static TransitRegionStateProcedure unassign(MasterProcedureEnv env,
                                                   RegionInfo region)

reopen

public static TransitRegionStateProcedure reopen(MasterProcedureEnv env,
                                                 RegionInfo region)

move

public static TransitRegionStateProcedure move(MasterProcedureEnv env,
                                               RegionInfo region,
                                               @Nullable
                                               ServerName targetServer)