org.apache.hadoop.hbase.master.assignment

Class RegionStates

java.lang.Object

org.apache.hadoop.hbase.master.assignment.RegionStates

@InterfaceAudience.Private
public class RegionStates
extends Object

RegionStates contains a set of Maps that describes the in-memory state of the AM, with the regions available in the system, the region in transition, the offline regions and the servers holding regions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	RegionStates.AssignmentProcedureEvent
static class	RegionStates.RegionFailedOpen
static class	RegionStates.RegionStateNode Current Region State.
private static class	RegionStates.RegionStateStampComparator
private static class	RegionStates.ServerReportEvent
static class	RegionStates.ServerState Server State.
static class	RegionStates.ServerStateNode State of Server; list of hosted regions, etc.

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG
static RegionStates.RegionStateStampComparator	REGION_STATE_STAMP_COMPARATOR
private ConcurrentSkipListMap<byte[],RegionStates.RegionFailedOpen>	regionFailedOpen
private ConcurrentSkipListMap<RegionInfo,RegionStates.RegionStateNode>	regionInTransition
private ConcurrentSkipListMap<RegionInfo,RegionStates.RegionStateNode>	regionOffline Regions marked as offline on a read of hbase:meta.
private ConcurrentSkipListMap<byte[],RegionStates.RegionStateNode>	regionsMap RegionName -- i.e.
private ConcurrentHashMap<ServerName,RegionStates.ServerStateNode>	serverMap
protected static RegionState.State[]	STATES_EXPECTED_ON_CLOSE
protected static RegionState.State[]	STATES_EXPECTED_ON_OPEN

Constructor Summary

Constructors

Constructor and Description
RegionStates()

Method Summary

Modifier and Type	Method and Description
protected boolean	addRegionInTransition(RegionStates.RegionStateNode regionNode, RegionTransitionProcedure procedure)
(package private) RegionStates.ServerStateNode	addRegionToServer(RegionStates.RegionStateNode regionNode) Add reference to region to serverstatenode.
RegionStates.RegionFailedOpen	addToFailedOpen(RegionStates.RegionStateNode regionNode)
void	addToOfflineRegions(RegionStates.RegionStateNode regionNode)
HRegionLocation	checkReopened(HRegionLocation oldLoc) Check whether the region has been reopened.
void	clear()
private HRegionLocation	createRegionForReopen(RegionStates.RegionStateNode node)
protected RegionStates.RegionStateNode	createRegionStateNode(RegionInfo regionInfo)
void	deleteRegion(RegionInfo regionInfo)
void	deleteRegions(List<RegionInfo> regionInfos)
List<RegionInfo>	getAssignedRegions()
Map<TableName,Map<ServerName,List<RegionInfo>>>	getAssignmentsByTable()
Map<TableName,Map<ServerName,List<RegionInfo>>>	getAssignmentsByTable(boolean forceByCluster) This is an EXPENSIVE clone.
double	getAverageLoad()
RegionStates.RegionFailedOpen	getFailedOpen(RegionInfo regionInfo)
protected RegionStates.RegionStateNode	getOrCreateRegionStateNode(RegionInfo regionInfo)
(package private) RegionStates.ServerStateNode	getOrCreateServer(ServerName serverName) Be judicious calling this method.
Map<RegionInfo,ServerName>	getRegionAssignments()
Map<RegionState.State,List<RegionInfo>>	getRegionByStateOfTable(TableName tableName)
List<RegionState>	getRegionFailedOpen()
ServerName	getRegionServerOfRegion(RegionInfo regionInfo)
List<RegionStates.RegionStateNode>	getRegionsInTransition()
int	getRegionsInTransitionCount() Get the number of regions in transition.
SortedSet<RegionState>	getRegionsInTransitionOrderedByTimestamp()
List<RegionInfo>	getRegionsOfTable(TableName table)
List<RegionInfo>	getRegionsOfTable(TableName table, boolean offline)
private List<RegionInfo>	getRegionsOfTable(TableName table, Predicate<RegionStates.RegionStateNode> filter)
List<HRegionLocation>	getRegionsOfTableForReopen(TableName tableName) Get the regions to be reopened when modifying a table.
List<RegionState>	getRegionsStateInTransition()
RegionState	getRegionState(RegionInfo regionInfo)
RegionState	getRegionState(String encodedRegionName)
RegionStates.RegionStateNode	getRegionStateNode(RegionInfo regionInfo)
(package private) RegionStates.RegionStateNode	getRegionStateNodeFromName(byte[] regionName)
(package private) Collection<RegionStates.RegionStateNode>	getRegionStateNodes()
ArrayList<RegionState>	getRegionStates()
RegionTransitionProcedure	getRegionTransitionProcedure(RegionInfo hri)
RegionState	getRegionTransitionState(RegionInfo hri)
RegionStates.ServerStateNode	getServerNode(ServerName serverName)
List<RegionInfo>	getServerRegionInfoSet(ServerName serverName) Returns the set of regions hosted by the specified server
Map<ServerName,List<RegionInfo>>	getSnapShotOfAssignment(Collection<RegionInfo> regions)
(package private) ArrayList<RegionInfo>	getTableRegionsInfo(TableName tableName)
(package private) ArrayList<RegionStates.RegionStateNode>	getTableRegionStateNodes(TableName tableName)
(package private) ArrayList<RegionState>	getTableRegionStates(TableName tableName)
boolean	hasRegionsInTransition()
boolean	hasTableRegionStates(TableName tableName)
(package private) boolean	include(RegionStates.RegionStateNode node, boolean offline) Utility.
boolean	isRegionInRegionStates(RegionInfo hri)
boolean	isRegionInState(RegionInfo regionInfo, RegionState.State... state)
boolean	isRegionInTransition(RegionInfo regionInfo)
boolean	isRegionOffline(RegionInfo regionInfo)
boolean	isRegionOnline(RegionInfo regionInfo)
void	logSplit(ServerName serverName) Called after we've split all logs on a crashed Server.
void	logSplitting(ServerName serverName) Call this when we start log splitting for a crashed Server.
void	metaLogSplit(ServerName serverName) Called after we've split the meta logs on a crashed Server.
void	metaLogSplitting(ServerName serverName) Call this when we start meta log splitting a crashed Server.
static String	regionNamesToString(Collection<byte[]> regions)
void	removeFromFailedOpen(RegionInfo regionInfo)
void	removeFromOfflineRegions(RegionInfo regionInfo)
RegionStates.ServerStateNode	removeRegionFromServer(ServerName serverName, RegionStates.RegionStateNode regionNode)
protected void	removeRegionInTransition(RegionStates.RegionStateNode regionNode, RegionTransitionProcedure procedure)
void	removeServer(ServerName serverName)
private void	setServerState(ServerName serverName, RegionStates.ServerState state)
void	updateRegionState(RegionInfo regionInfo, RegionState.State state)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

STATES_EXPECTED_ON_OPEN

protected static final RegionState.State[] STATES_EXPECTED_ON_OPEN

STATES_EXPECTED_ON_CLOSE

protected static final RegionState.State[] STATES_EXPECTED_ON_CLOSE

REGION_STATE_STAMP_COMPARATOR

public static final RegionStates.RegionStateStampComparator REGION_STATE_STAMP_COMPARATOR

regionsMap

private final ConcurrentSkipListMap<byte[],RegionStates.RegionStateNode> regionsMap

RegionName -- i.e. RegionInfo.getRegionName() -- as bytes to RegionStates.RegionStateNode

regionInTransition

private final ConcurrentSkipListMap<RegionInfo,RegionStates.RegionStateNode> regionInTransition

regionOffline

private final ConcurrentSkipListMap<RegionInfo,RegionStates.RegionStateNode> regionOffline

Regions marked as offline on a read of hbase:meta. Unused or at least, once offlined, regions have no means of coming on line again. TODO.

regionFailedOpen

private final ConcurrentSkipListMap<byte[],RegionStates.RegionFailedOpen> regionFailedOpen

serverMap

private final ConcurrentHashMap<ServerName,RegionStates.ServerStateNode> serverMap

Constructor Detail

RegionStates

public RegionStates()

Method Detail

clear

public void clear()

isRegionInRegionStates

public boolean isRegionInRegionStates(RegionInfo hri)

createRegionStateNode

protected RegionStates.RegionStateNode createRegionStateNode(RegionInfo regionInfo)

getOrCreateRegionStateNode

protected RegionStates.RegionStateNode getOrCreateRegionStateNode(RegionInfo regionInfo)

getRegionStateNodeFromName

RegionStates.RegionStateNode getRegionStateNodeFromName(byte[] regionName)

getRegionStateNode

public RegionStates.RegionStateNode getRegionStateNode(RegionInfo regionInfo)

deleteRegion

public void deleteRegion(RegionInfo regionInfo)

deleteRegions

public void deleteRegions(List<RegionInfo> regionInfos)

getTableRegionStateNodes

ArrayList<RegionStates.RegionStateNode> getTableRegionStateNodes(TableName tableName)

getTableRegionStates

ArrayList<RegionState> getTableRegionStates(TableName tableName)

getTableRegionsInfo

ArrayList<RegionInfo> getTableRegionsInfo(TableName tableName)

getRegionStateNodes

Collection<RegionStates.RegionStateNode> getRegionStateNodes()

getRegionStates

public ArrayList<RegionState> getRegionStates()

getRegionState

public RegionState getRegionState(RegionInfo regionInfo)

getRegionState

public RegionState getRegionState(String encodedRegionName)

hasTableRegionStates

public boolean hasTableRegionStates(TableName tableName)

getRegionsOfTable

public List<RegionInfo> getRegionsOfTable(TableName table)

Returns:

Return online regions of table; does not include OFFLINE or SPLITTING regions.

createRegionForReopen

private HRegionLocation createRegionForReopen(RegionStates.RegionStateNode node)

getRegionsOfTableForReopen

public List<HRegionLocation> getRegionsOfTableForReopen(TableName tableName)

Get the regions to be reopened when modifying a table.

Notice that the openSeqNum in the returned HRegionLocation is also used to indicate the state of this region, positive means the region is in RegionState.State.OPEN, -1 means RegionState.State.OPENING. And for regions in other states we do not need reopen them.

checkReopened

public HRegionLocation checkReopened(HRegionLocation oldLoc)

Check whether the region has been reopened. The meaning of the HRegionLocation is the same with getRegionsOfTableForReopen(TableName).

For a region which is in RegionState.State.OPEN before, if the region state is changed or the open seq num is changed, we can confirm that it has been reopened.

For a region which is in RegionState.State.OPENING before, usually it will be in RegionState.State.OPEN now and we will schedule a MRP to reopen it. But there are several exceptions:

• The region is in state other than RegionState.State.OPEN or RegionState.State.OPENING.
• The location of the region has been changed

Of course the region could still be in RegionState.State.OPENING state and still on the same server, then here we will still return a HRegionLocation for it, just like getRegionsOfTableForReopen(TableName).

Parameters:

oldLoc - the previous state/location of this region

Returns:

null if the region has been reopened, otherwise a new HRegionLocation which means we still need to reopen the region.

See Also:

getRegionsOfTableForReopen(TableName)

getRegionsOfTable

public List<RegionInfo> getRegionsOfTable(TableName table,
                                          boolean offline)

Returns:

Return online regions of table; does not include OFFLINE or SPLITTING regions.

getRegionsOfTable

private List<RegionInfo> getRegionsOfTable(TableName table,
                                           Predicate<RegionStates.RegionStateNode> filter)

Returns:

Return the regions of the table; does not include OFFLINE unless you set offline to true. Does not include regions that are in the RegionState.State.SPLIT state.

include

boolean include(RegionStates.RegionStateNode node,
                boolean offline)

Utility. Whether to include region in list of regions. Default is to weed out split and offline regions.

Returns:

True if we should include the node (do not include if split or offline unless offline is set to true.

getServerRegionInfoSet

public List<RegionInfo> getServerRegionInfoSet(ServerName serverName)

Returns the set of regions hosted by the specified server

Parameters:

serverName - the server we are interested in

Returns:

set of RegionInfo hosted by the specified server

setServerState

private void setServerState(ServerName serverName,
                            RegionStates.ServerState state)

metaLogSplitting

public void metaLogSplitting(ServerName serverName)

Call this when we start meta log splitting a crashed Server.

See Also:

metaLogSplit(ServerName)

metaLogSplit

public void metaLogSplit(ServerName serverName)

Called after we've split the meta logs on a crashed Server.

See Also:

metaLogSplitting(ServerName)

logSplitting

public void logSplitting(ServerName serverName)

Call this when we start log splitting for a crashed Server.

See Also:

logSplit(ServerName)

logSplit

public void logSplit(ServerName serverName)

Called after we've split all logs on a crashed Server.

See Also:

logSplitting(ServerName)

updateRegionState

public void updateRegionState(RegionInfo regionInfo,
                              RegionState.State state)

getAssignedRegions

public List<RegionInfo> getAssignedRegions()

isRegionInState

public boolean isRegionInState(RegionInfo regionInfo,
                               RegionState.State... state)

isRegionOnline

public boolean isRegionOnline(RegionInfo regionInfo)

isRegionOffline

public boolean isRegionOffline(RegionInfo regionInfo)

Returns:

True if region is offline (In OFFLINE or CLOSED state).

getSnapShotOfAssignment

public Map<ServerName,List<RegionInfo>> getSnapShotOfAssignment(Collection<RegionInfo> regions)

getRegionAssignments

public Map<RegionInfo,ServerName> getRegionAssignments()

getRegionByStateOfTable

public Map<RegionState.State,List<RegionInfo>> getRegionByStateOfTable(TableName tableName)

getRegionServerOfRegion

public ServerName getRegionServerOfRegion(RegionInfo regionInfo)

getAssignmentsByTable

public Map<TableName,Map<ServerName,List<RegionInfo>>> getAssignmentsByTable(boolean forceByCluster)

This is an EXPENSIVE clone. Cloning though is the safest thing to do. Can't let out original since it can change and at least the load balancer wants to iterate this exported list. We need to synchronize on regions since all access to this.servers is under a lock on this.regions.

Parameters:

forceByCluster - a flag to force to aggregate the server-load to the cluster level

Returns:

A clone of current assignments by table.

getAssignmentsByTable

public Map<TableName,Map<ServerName,List<RegionInfo>>> getAssignmentsByTable()

addRegionInTransition

protected boolean addRegionInTransition(RegionStates.RegionStateNode regionNode,
                                        RegionTransitionProcedure procedure)

removeRegionInTransition

protected void removeRegionInTransition(RegionStates.RegionStateNode regionNode,
                                        RegionTransitionProcedure procedure)

hasRegionsInTransition

public boolean hasRegionsInTransition()

isRegionInTransition

public boolean isRegionInTransition(RegionInfo regionInfo)

getRegionTransitionProcedure

public RegionTransitionProcedure getRegionTransitionProcedure(RegionInfo hri)

Returns:

If a procedure-in-transition for hri, return it else null.

getRegionTransitionState

public RegionState getRegionTransitionState(RegionInfo hri)

getRegionsInTransition

public List<RegionStates.RegionStateNode> getRegionsInTransition()

getRegionsInTransitionCount

public int getRegionsInTransitionCount()

Get the number of regions in transition.

getRegionsStateInTransition

public List<RegionState> getRegionsStateInTransition()

getRegionsInTransitionOrderedByTimestamp

public SortedSet<RegionState> getRegionsInTransitionOrderedByTimestamp()

addToOfflineRegions

public void addToOfflineRegions(RegionStates.RegionStateNode regionNode)

removeFromOfflineRegions

public void removeFromOfflineRegions(RegionInfo regionInfo)

addToFailedOpen

public RegionStates.RegionFailedOpen addToFailedOpen(RegionStates.RegionStateNode regionNode)

getFailedOpen

public RegionStates.RegionFailedOpen getFailedOpen(RegionInfo regionInfo)

removeFromFailedOpen

public void removeFromFailedOpen(RegionInfo regionInfo)

getRegionFailedOpen

public List<RegionState> getRegionFailedOpen()

getOrCreateServer

RegionStates.ServerStateNode getOrCreateServer(ServerName serverName)

Be judicious calling this method. Do it on server register ONLY otherwise you could mess up online server accounting. TOOD: Review usage and convert to getServerNode(ServerName) where we can.

removeServer

public void removeServer(ServerName serverName)

getServerNode

public RegionStates.ServerStateNode getServerNode(ServerName serverName)

getAverageLoad

public double getAverageLoad()

addRegionToServer

RegionStates.ServerStateNode addRegionToServer(RegionStates.RegionStateNode regionNode)

Add reference to region to serverstatenode. DOES NOT AUTO-CREATE ServerStateNode instance.

Returns:

Return serverstatenode or null if none.

removeRegionFromServer

public RegionStates.ServerStateNode removeRegionFromServer(ServerName serverName,
                                                           RegionStates.RegionStateNode regionNode)

regionNamesToString

public static String regionNamesToString(Collection<byte[]> regions)