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

Class SplitWALProcedure

java.lang.Object

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

org.apache.hadoop.hbase.procedure2.StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.SplitWALState>

org.apache.hadoop.hbase.master.procedure.SplitWALProcedure

All Implemented Interfaces:

Comparable<Procedure<MasterProcedureEnv>>, ServerProcedureInterface

@Private
public class SplitWALProcedure
extends StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.SplitWALState>
implements ServerProcedureInterface

The procedure is to split a WAL. It will get an available region server and schedule a SplitWALRemoteProcedure to actually send the request to region server to split this WAL. It also check if the split wal task really succeed. If the WAL still exists, it will schedule another region server to split this WAL.

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

ServerProcedureInterface.ServerOperationType

Field Summary

Fields

Modifier and Type	Field	Description
private ServerName	crashedServer
private static final org.slf4j.Logger	LOG
private RetryCounter	retryCounter
private String	walPath
private ServerName	worker

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	Description
SplitWALProcedure()
SplitWALProcedure(String walPath, ServerName crashedServer)

Method Summary

Modifier and Type	Method	Description
protected void	afterReplay(MasterProcedureEnv env)	Called when the procedure is ready to be added to the queue after the loading/replay operation.
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.SplitWALState state)	called to perform a single step of the specified 'state' of the procedure
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.SplitWALState	getInitialState()	Return the initial state object that will be used for the first call to executeFromState().
String	getProcName()
ServerName	getServerName()	Returns Name of this server instance.
ServerProcedureInterface.ServerOperationType	getServerOperationType()	Given an operation type we can take decisions about what to do with pending operations.
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.SplitWALState	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.SplitWALState state)	Convert the Enum (or more descriptive) state object to an ordinal (or state id).
String	getWAL()
(package private) static String	getWALNameFromStrPath(String path)
ServerName	getWorker()
boolean	hasMetaTableRegion()	Returns True if this server has an hbase:meta table region.
protected void	rollbackState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.SplitWALState splitOneWalState)	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.
protected boolean	setTimeoutFailure(MasterProcedureEnv env)	Called by the ProcedureExecutor when the timeout set by setTimeout() is expired.
protected void	toStringClassDetails(StringBuilder builder)	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, isRollbackSupported, isYieldAfterExecutionStep, isYieldBeforeExecuteFromState, rollback, setNextState, toStringState

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

acquireLock, addStackIndex, afterExec, beforeExec, 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, releaseLock, 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, waitInitialized, 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

walPath

private String walPath

worker

private ServerName worker

crashedServer

private ServerName crashedServer

retryCounter

private RetryCounter retryCounter

Constructor Details

SplitWALProcedure

public SplitWALProcedure()

SplitWALProcedure

public SplitWALProcedure(String walPath,
 ServerName crashedServer)

Method Details

executeFromState

protected StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env,
 org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.SplitWALState 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.SplitWALState>

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,
 org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.SplitWALState splitOneWalState)
                      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.SplitWALState>

splitOneWalState - state to rollback

Throws:

IOException - temporary failure, the rollback will retry later

InterruptedException

getState

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

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

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

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

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

Parameters:

serializer - contains the serialized state

Throws:

IOException

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.

getWAL

public String getWAL()

getWorker

public ServerName getWorker()

getServerName

public ServerName getServerName()

Description copied from interface: ServerProcedureInterface

Returns Name of this server instance.

Specified by:

getServerName in interface ServerProcedureInterface

hasMetaTableRegion

public boolean hasMetaTableRegion()

Description copied from interface: ServerProcedureInterface

Returns True if this server has an hbase:meta table region.

Specified by:

hasMetaTableRegion in interface ServerProcedureInterface

getServerOperationType

public ServerProcedureInterface.ServerOperationType getServerOperationType()

Description copied from interface: ServerProcedureInterface

Given an operation type we can take decisions about what to do with pending operations. e.g. if we get a crash handler and we have some assignment operation pending we can abort those operations.

Specified by:

getServerOperationType in interface ServerProcedureInterface

Returns:

the operation type that the procedure is executing.

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>

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

getProcName

public String getProcName()

Overrides:

getProcName in class Procedure<MasterProcedureEnv>

getWALNameFromStrPath

static String getWALNameFromStrPath(String path)

Returns:

Return the WAL filename when given a Path-as-a-string; i.e. return the last path component only.