org.apache.hadoop.hbase.master.procedure

Class RecoverMetaProcedure

java.lang.Object

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

org.apache.hadoop.hbase.procedure2.StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.RecoverMetaState>

org.apache.hadoop.hbase.master.procedure.RecoverMetaProcedure

All Implemented Interfaces:

Comparable<Procedure<MasterProcedureEnv>>, MetaProcedureInterface

Deprecated.

Do not use any more, leave it here only for compatible. The recovery work will be done in ServerCrashProcedure directly, and the initial work for meta table will be done by InitMetaProcedure.

@Deprecated
 @InterfaceAudience.Private
public class RecoverMetaProcedure
extends StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.RecoverMetaState>
implements MetaProcedureInterface

This procedure recovers meta from prior shutdown/ crash of a server, and brings meta online by assigning meta region/s. Any place where meta is accessed and requires meta to be online, need to submit this procedure instead of duplicating steps to recover meta in the code.

See Also:

ServerCrashProcedure, InitMetaProcedure

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.MetaProcedureInterface

MetaProcedureInterface.MetaOperationType

Field Summary

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

Constructor Summary

Constructors

Constructor and Description
RecoverMetaProcedure() Deprecated. This constructor is also used when deserializing from a procedure store; we'll construct one of these then call #deserializeStateData(InputStream).
RecoverMetaProcedure(ServerName failedMetaServer, boolean shouldSplitLog) Deprecated. Call this constructor to queue up a RecoverMetaProcedure in response to meta carrying server crash
RecoverMetaProcedure(ServerName failedMetaServer, boolean shouldSplitLog, ProcedurePrepareLatch latch) Deprecated. Constructor with latch, for blocking/ sync usage

Method Summary

Modifier and Type	Method and Description
protected Procedure.LockState	acquireLock(MasterProcedureEnv env) Deprecated. The user should override this method if they need a lock on an Entity.
protected void	completionCleanup(MasterProcedureEnv env) Deprecated. Called when the procedure is marked as completed (success or rollback).
protected void	deserializeStateData(ProcedureStateSerializer serializer) Deprecated. Called on store load to allow the user to decode the previously serialized state.
protected StateMachineProcedure.Flow	executeFromState(MasterProcedureEnv env, MasterProcedureProtos.RecoverMetaState state) Deprecated. called to perform a single step of the specified 'state' of the procedure
protected MasterProcedureProtos.RecoverMetaState	getInitialState() Deprecated. Return the initial state object that will be used for the first call to executeFromState().
protected MasterProcedureProtos.RecoverMetaState	getState(int stateId) Deprecated. Convert an ordinal (or state id) to an Enum (or more descriptive) state object.
protected int	getStateId(MasterProcedureProtos.RecoverMetaState recoverMetaState) Deprecated. Convert the Enum (or more descriptive) state object to an ordinal (or state id).
protected void	releaseLock(MasterProcedureEnv env) Deprecated. The user should override this method, and release lock if necessary.
protected void	rollbackState(MasterProcedureEnv env, MasterProcedureProtos.RecoverMetaState recoverMetaState) Deprecated. called to perform the rollback of the specified state
protected void	serializeStateData(ProcedureStateSerializer serializer) Deprecated. The user-level code of the procedure may have some state to persist (e.g.
protected void	toStringClassDetails(StringBuilder sb) Deprecated. Extend the toString() information with the procedure details e.g.

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

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

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

addStackIndex, afterReplay, beforeReplay, bypass, compareTo, 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, setFailure, setFailure, setLastUpdate, setNonceKey, setOwner, setOwner, setParentProcId, setProcId, setResult, setRootProcId, setStackIndexes, setState, setSubmittedTime, setTimeout, setTimeoutFailure, shouldWaitClientAck, skipPersistence, toString, toStringClass, toStringDetails, toStringSimpleSB, updateMetricsOnFinish, updateMetricsOnSubmit, updateTimestamp, waitInitialized, 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.MetaProcedureInterface

getMetaOperationType

Constructor Detail

RecoverMetaProcedure

public RecoverMetaProcedure(ServerName failedMetaServer,
                            boolean shouldSplitLog)

Deprecated.

Call this constructor to queue up a RecoverMetaProcedure in response to meta carrying server crash

Parameters:

failedMetaServer - failed/ crashed region server that was carrying meta

shouldSplitLog - split log file of meta region

RecoverMetaProcedure

public RecoverMetaProcedure(ServerName failedMetaServer,
                            boolean shouldSplitLog,
                            ProcedurePrepareLatch latch)

Deprecated.

Constructor with latch, for blocking/ sync usage

RecoverMetaProcedure

public RecoverMetaProcedure()

Deprecated.

This constructor is also used when deserializing from a procedure store; we'll construct one of these then call #deserializeStateData(InputStream). Do not use directly.

Method Detail

executeFromState

protected StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env,
                                                      MasterProcedureProtos.RecoverMetaState state)
                                               throws ProcedureSuspendedException,
                                                      ProcedureYieldException,
                                                      InterruptedException

Deprecated.

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,MasterProcedureProtos.RecoverMetaState>

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

rollbackState

protected void rollbackState(MasterProcedureEnv env,
                             MasterProcedureProtos.RecoverMetaState recoverMetaState)
                      throws IOException,
                             InterruptedException

Deprecated.

Description copied from class: StateMachineProcedure

called to perform the rollback of the specified state

Specified by:

rollbackState in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.RecoverMetaState>

recoverMetaState - state to rollback

Throws:

IOException - temporary failure, the rollback will retry later

InterruptedException

getState

protected MasterProcedureProtos.RecoverMetaState getState(int stateId)

Deprecated.

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,MasterProcedureProtos.RecoverMetaState>

Parameters:

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

Returns:

the state enum object

getStateId

protected int getStateId(MasterProcedureProtos.RecoverMetaState recoverMetaState)

Deprecated.

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,MasterProcedureProtos.RecoverMetaState>

Parameters:

recoverMetaState - the state enum object

Returns:

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

getInitialState

protected MasterProcedureProtos.RecoverMetaState getInitialState()

Deprecated.

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,MasterProcedureProtos.RecoverMetaState>

Returns:

the initial state enum object

toStringClassDetails

protected void toStringClassDetails(StringBuilder sb)

Deprecated.

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:

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

serializeStateData

protected void serializeStateData(ProcedureStateSerializer serializer)
                           throws IOException

Deprecated.

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,MasterProcedureProtos.RecoverMetaState>

Parameters:

serializer - stores the serializable state

Throws:

IOException

deserializeStateData

protected void deserializeStateData(ProcedureStateSerializer serializer)
                             throws IOException

Deprecated.

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,MasterProcedureProtos.RecoverMetaState>

Parameters:

serializer - contains the serialized state

Throws:

IOException

acquireLock

protected Procedure.LockState acquireLock(MasterProcedureEnv env)

Deprecated.

Description copied from class: Procedure

The user should override this method if they need a lock on an Entity. A lock can be anything, and it is up to the implementor. The Procedure Framework will call this method just before it invokes Procedure.execute(Object). It calls Procedure.releaseLock(Object) after the call to execute.

If you need to hold the lock for the life of the Procedure -- i.e. you do not want any other Procedure interfering while this Procedure is running, see Procedure.holdLock(Object).

Example: in our Master we can execute request in parallel for different tables. We can create t1 and create t2 and these creates can be executed at the same time. Anything else on t1/t2 is queued waiting that specific table create to happen.

There are 3 LockState:

• LOCK_ACQUIRED should be returned when the proc has the lock and the proc is ready to execute.
• LOCK_YIELD_WAIT should be returned when the proc has not the lock and the framework should take care of readding the procedure back to the runnable set for retry
• LOCK_EVENT_WAIT should be returned when the proc has not the lock and someone will take care of readding the procedure back to the runnable set when the lock is available.

Overrides:

acquireLock in class Procedure<MasterProcedureEnv>

Returns:

the lock state as described above.

releaseLock

protected void releaseLock(MasterProcedureEnv env)

Deprecated.

Description copied from class: Procedure

The user should override this method, and release lock if necessary.

Overrides:

releaseLock in class Procedure<MasterProcedureEnv>

completionCleanup

protected void completionCleanup(MasterProcedureEnv env)

Deprecated.

Description copied from class: Procedure

Called when the procedure is marked as completed (success or rollback). The procedure implementor may use this method to cleanup in-memory states. This operation will not be retried on failure. If a procedure took a lock, it will have been released when this method runs.

Overrides:

completionCleanup in class Procedure<MasterProcedureEnv>