Package org.apache.hadoop.hbase.master.procedure

Class ReopenTableRegionsProcedure

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<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ReopenTableRegionsState>

org.apache.hadoop.hbase.master.procedure.ReopenTableRegionsProcedure

All Implemented Interfaces:

Comparable<Procedure<MasterProcedureEnv>>, TableProcedureInterface

@Private
public class ReopenTableRegionsProcedure
extends AbstractStateMachineTableProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ReopenTableRegionsState>

Used for reopening the regions for a table.

Nested Class Summary

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

Modifier and Type	Field	Description
private long	batchesProcessed
private List<HRegionLocation>	currentRegionBatch
private static final org.slf4j.Logger	LOG
private static final int	MINIMUM_BATCH_SIZE_MAX
static final long	PROGRESSIVE_BATCH_BACKOFF_MILLIS_DEFAULT
static final String	PROGRESSIVE_BATCH_BACKOFF_MILLIS_KEY
private static final int	PROGRESSIVE_BATCH_SIZE_MAX_DEFAULT_VALUE
static final int	PROGRESSIVE_BATCH_SIZE_MAX_DISABLED
static final String	PROGRESSIVE_BATCH_SIZE_MAX_KEY
private List<byte[]>	regionNames
private List<HRegionLocation>	regions
private long	regionsReopened
private long	reopenBatchBackoffMillis
private int	reopenBatchSize
private int	reopenBatchSizeMax
private RetryCounter	retryCounter
private TableName	tableName

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

stateCount

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

NO_PROC_ID, NO_TIMEOUT

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

DUMMY_NAMESPACE_TABLE_NAME

Constructor Summary

Constructors

Constructor	Description
ReopenTableRegionsProcedure()
ReopenTableRegionsProcedure(TableName tableName)
ReopenTableRegionsProcedure(TableName tableName, long reopenBatchBackoffMillis, int reopenBatchSizeMax)
ReopenTableRegionsProcedure(TableName tableName, List<byte[]> regionNames)
ReopenTableRegionsProcedure(TableName tableName, List<byte[]> regionNames, long reopenBatchBackoffMillis, int reopenBatchSizeMax)

Method Summary

Modifier and Type	Method	Description
private boolean	canSchedule(MasterProcedureEnv env, HRegionLocation loc)
protected void	deserializeStateData(ProcedureStateSerializer serializer)	Called on store load to allow the user to decode the previously serialized state.
protected StateMachineProcedure.Flow	executeFromState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ReopenTableRegionsState state)	called to perform a single step of the specified 'state' of the procedure
private List<HRegionLocation>	filterReopened(MasterProcedureEnv env, List<HRegionLocation> regionsToCheck)
long	getBatchesProcessed()
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ReopenTableRegionsState	getInitialState()	Return the initial state object that will be used for the first call to executeFromState().
private List<HRegionLocation>	getRegionLocationsForReopen(List<HRegionLocation> tableRegionsForReopen)
long	getRegionsReopened()
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ReopenTableRegionsState	getState(int stateId)	Convert an ordinal (or state id) to an Enum (or more descriptive) state object.
protected int	getStateId(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ReopenTableRegionsState state)	Convert the Enum (or more descriptive) state object to an ordinal (or state id).
TableName	getTableName()	Returns the name of the table the procedure is operating on
TableProcedureInterface.TableOperationType	getTableOperationType()	Given an operation type we can take decisions about what to do with pending operations.
protected int	progressBatchSize()
private StateMachineProcedure.Flow	reopenIfSchedulable(MasterProcedureEnv env, List<HRegionLocation> regionsToReopen, boolean shouldBatchBackoff)
protected void	rollbackState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ReopenTableRegionsState state)	called to perform the rollback of the specified state
protected void	serializeStateData(ProcedureStateSerializer serializer)	The user-level code of the procedure may have some state to persist (e.g.
private void	setBackoffState(long millis)
protected boolean	setTimeoutFailure(MasterProcedureEnv env)	At end of timeout, wake ourselves up so we run again.

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

acquireLock, checkOnline, checkTableModifiable, getUser, getWALRegionDir, isTableEnabled, preflightChecks, releaseLock, releaseSyncLatch, setUser, toStringClassDetails, waitInitialized

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

abort, addChildProcedure, execute, failIfAborted, getCurrentState, getCurrentStateId, getCycles, isEofState, isRollbackSupported, 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, getProcedureMetrics, getProcId, getProcIdHashCode, getProcName, 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, removeStackIndex, setAbortFailure, setChildrenLatch, setExecuted, setFailure, setFailure, setLastUpdate, setNonceKey, setOwner, setOwner, setParentProcId, setProcId, setResult, setRootProcId, setStackIndexes, setState, setSubmittedTime, setTimeout, shouldWaitClientAck, skipPersistence, suspend, 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

Field Details

LOG

private static final org.slf4j.Logger LOG

PROGRESSIVE_BATCH_BACKOFF_MILLIS_KEY

public static final String PROGRESSIVE_BATCH_BACKOFF_MILLIS_KEY

See Also:

• Constant Field Values

PROGRESSIVE_BATCH_BACKOFF_MILLIS_DEFAULT

public static final long PROGRESSIVE_BATCH_BACKOFF_MILLIS_DEFAULT

See Also:

• Constant Field Values

PROGRESSIVE_BATCH_SIZE_MAX_KEY

public static final String PROGRESSIVE_BATCH_SIZE_MAX_KEY

See Also:

• Constant Field Values

PROGRESSIVE_BATCH_SIZE_MAX_DISABLED

public static final int PROGRESSIVE_BATCH_SIZE_MAX_DISABLED

See Also:

• Constant Field Values

PROGRESSIVE_BATCH_SIZE_MAX_DEFAULT_VALUE

private static final int PROGRESSIVE_BATCH_SIZE_MAX_DEFAULT_VALUE

See Also:

• Constant Field Values

MINIMUM_BATCH_SIZE_MAX

private static final int MINIMUM_BATCH_SIZE_MAX

See Also:

• Constant Field Values

tableName

private TableName tableName

regionNames

private List<byte[]> regionNames

regions

private List<HRegionLocation> regions

currentRegionBatch

private List<HRegionLocation> currentRegionBatch

retryCounter

private RetryCounter retryCounter

reopenBatchBackoffMillis

private long reopenBatchBackoffMillis

reopenBatchSize

private int reopenBatchSize

reopenBatchSizeMax

private int reopenBatchSizeMax

regionsReopened

private long regionsReopened

batchesProcessed

private long batchesProcessed

Constructor Details

ReopenTableRegionsProcedure

public ReopenTableRegionsProcedure()

ReopenTableRegionsProcedure

public ReopenTableRegionsProcedure(TableName tableName)

ReopenTableRegionsProcedure

public ReopenTableRegionsProcedure(TableName tableName,
 List<byte[]> regionNames)

ReopenTableRegionsProcedure

public ReopenTableRegionsProcedure(TableName tableName,
 long reopenBatchBackoffMillis,
 int reopenBatchSizeMax)

ReopenTableRegionsProcedure

public ReopenTableRegionsProcedure(TableName tableName,
 List<byte[]> regionNames,
 long reopenBatchBackoffMillis,
 int reopenBatchSizeMax)

Method Details

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

Specified by:

getTableName in class AbstractStateMachineTableProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ReopenTableRegionsState>

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 AbstractStateMachineTableProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ReopenTableRegionsState>

Returns:

the operation type that the procedure is executing.

getRegionsReopened

public long getRegionsReopened()

getBatchesProcessed

public long getBatchesProcessed()

progressBatchSize

protected int progressBatchSize()

canSchedule

private boolean canSchedule(MasterProcedureEnv env,
 HRegionLocation loc)

executeFromState

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

Description copied from class: StateMachineProcedure

called to perform a single step of the specified 'state' of the procedure

Specified by:

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

state - state to execute

Returns:

Flow.NO_MORE_STATE if the procedure is completed, Flow.HAS_MORE_STATE if there is another step.

Throws:

ProcedureSuspendedException

ProcedureYieldException

InterruptedException

filterReopened

private List<HRegionLocation> filterReopened(MasterProcedureEnv env,
 List<HRegionLocation> regionsToCheck)

reopenIfSchedulable

private StateMachineProcedure.Flow reopenIfSchedulable(MasterProcedureEnv env,
 List<HRegionLocation> regionsToReopen,
 boolean shouldBatchBackoff)
                                                throws ProcedureSuspendedException

Throws:

ProcedureSuspendedException

setBackoffState

private void setBackoffState(long millis)

getRegionLocationsForReopen

private List<HRegionLocation> getRegionLocationsForReopen(List<HRegionLocation> tableRegionsForReopen)

setTimeoutFailure

protected boolean setTimeoutFailure(MasterProcedureEnv env)

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

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.

rollbackState

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

Description copied from class: StateMachineProcedure

called to perform the rollback of the specified state

Specified by:

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

state - state to rollback

Throws:

IOException - temporary failure, the rollback will retry later

InterruptedException

getState

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

Description copied from class: StateMachineProcedure

Convert an ordinal (or state id) to an Enum (or more descriptive) state object.

Specified by:

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

Parameters:

stateId - the ordinal() of the state enum (or state id)

Returns:

the state enum object

getStateId

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

Description copied from class: StateMachineProcedure

Convert the Enum (or more descriptive) state object to an ordinal (or state id).

Specified by:

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

Parameters:

state - the state enum object

Returns:

stateId the ordinal() of the state enum (or state id)

getInitialState

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

Description copied from class: StateMachineProcedure

Return the initial state object that will be used for the first call to executeFromState().

Specified by:

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

Returns:

the initial state enum object

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.

Overrides:

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

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.

Overrides:

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

Parameters:

serializer - contains the serialized state

Throws:

IOException