alluxio.worker.block

Class BlockMetadataManager

java.lang.Object

alluxio.worker.block.BlockMetadataManager

@NotThreadSafe
public final class BlockMetadataManager
extends Object

Manages the metadata of all blocks in managed space. This information is used by the TieredBlockStore, Allocator and Evictor.

All operations on block metadata such as StorageTier, StorageDir should go through this class.

Method Summary

Modifier and Type	Method and Description
void	abortTempBlockMeta(TempBlockMeta tempBlockMeta) Aborts a temp block.
void	addTempBlockMeta(TempBlockMeta tempBlockMeta) Adds a temp block.
void	cleanupSessionTempBlocks(long sessionId, List<Long> tempBlockIds) Deprecated. As of version 0.8.
void	commitTempBlockMeta(TempBlockMeta tempBlockMeta) Commits a temp block.
static BlockMetadataManager	createBlockMetadataManager() Creates a new instance of BlockMetadataManager.
long	getAvailableBytes(BlockStoreLocation location) Gets the amount of available space of given location in bytes.
BlockIterator	getBlockIterator()
BlockMeta	getBlockMeta(long blockId) Gets the metadata of a block given its block id.
String	getBlockPath(long blockId, BlockStoreLocation location) Returns the path of a block given its location, or null if the location is not a specific StorageDir.
BlockStoreMeta	getBlockStoreMeta() Gets a summary of the metadata.
BlockStoreMeta	getBlockStoreMetaFull() Gets a full summary of block store metadata.
StorageDir	getDir(BlockStoreLocation location) Gets the StorageDir given its location in the store.
List<TempBlockMeta>	getSessionTempBlocks(long sessionId) Gets all the temporary blocks associated with a session, empty list is returned if the session has no temporary blocks.
StorageTierAssoc	getStorageTierAssoc()
TempBlockMeta	getTempBlockMeta(long blockId) Gets the metadata of a temp block.
TempBlockMeta	getTempBlockMetaOrNull(long blockId) Gets the metadata of a temp block.
StorageTier	getTier(String tierAlias) Gets the StorageTier given its tierAlias.
List<StorageTier>	getTiers() Gets the list of StorageTier managed.
List<StorageTier>	getTiersBelow(String tierAlias) Gets the list of StorageTier below the tier with the given tierAlias.
boolean	hasBlockMeta(long blockId) Checks if the storage has a given block.
boolean	hasTempBlockMeta(long blockId) Checks if the storage has a given temp block.
BlockMeta	moveBlockMeta(BlockMeta blockMeta, BlockStoreLocation newLocation) Deprecated. As of version 0.8. Use moveBlockMeta(BlockMeta, TempBlockMeta) instead.
BlockMeta	moveBlockMeta(BlockMeta blockMeta, TempBlockMeta tempBlockMeta) Moves an existing block to another location currently hold by a temp block.
void	removeBlockMeta(BlockMeta block) Removes the metadata of a specific block.
void	resizeTempBlockMeta(TempBlockMeta tempBlockMeta, long newSize) Modifies the size of a temp block.
void	swapBlocks(BlockMeta blockMeta1, BlockMeta blockMeta2) Swaps location of two blocks in metadata.

Methods inherited from class java.lang.Object

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

Method Detail

getBlockIterator

public BlockIterator getBlockIterator()

Returns:

the configured iteration provider

createBlockMetadataManager

public static BlockMetadataManager createBlockMetadataManager()

Creates a new instance of BlockMetadataManager.

Returns:

a BlockMetadataManager instance

abortTempBlockMeta

public void abortTempBlockMeta(TempBlockMeta tempBlockMeta)
                        throws BlockDoesNotExistException

Aborts a temp block.

Parameters:

tempBlockMeta - the metadata of the temp block to add

Throws:

BlockDoesNotExistException - when block can not be found

addTempBlockMeta

public void addTempBlockMeta(TempBlockMeta tempBlockMeta)
                      throws WorkerOutOfSpaceException,
                             BlockAlreadyExistsException

Adds a temp block.

Parameters:

tempBlockMeta - the metadata of the temp block to add

Throws:

WorkerOutOfSpaceException - when no more space left to hold the block

BlockAlreadyExistsException - when the block already exists

commitTempBlockMeta

public void commitTempBlockMeta(TempBlockMeta tempBlockMeta)
                         throws WorkerOutOfSpaceException,
                                BlockAlreadyExistsException,
                                BlockDoesNotExistException

Commits a temp block.

Parameters:

tempBlockMeta - the metadata of the temp block to commit

Throws:

WorkerOutOfSpaceException - when no more space left to hold the block

BlockAlreadyExistsException - when the block already exists in committed blocks

BlockDoesNotExistException - when temp block can not be found

swapBlocks

public void swapBlocks(BlockMeta blockMeta1,
                       BlockMeta blockMeta2)
                throws BlockDoesNotExistException,
                       BlockAlreadyExistsException,
                       WorkerOutOfSpaceException

Swaps location of two blocks in metadata.

Parameters:

blockMeta1 - the first block meta

blockMeta2 - the second block meta

Throws:

BlockDoesNotExistException

BlockAlreadyExistsException

WorkerOutOfSpaceException

cleanupSessionTempBlocks

@Deprecated
public void cleanupSessionTempBlocks(long sessionId,
                                                 List<Long> tempBlockIds)

Deprecated. As of version 0.8.

Cleans up the metadata of the given temp block ids.

Parameters:

sessionId - the id of the client associated with the temp blocks

tempBlockIds - the list of temporary block ids to be cleaned up, non temporary block ids will be ignored.

getAvailableBytes

public long getAvailableBytes(BlockStoreLocation location)

Gets the amount of available space of given location in bytes. Master queries the total number of bytes available on each tier of the worker, and Evictor/Allocator often cares about the bytes at a StorageDir. Throws an IllegalArgumentException when the location does not belong to the tiered storage.

Parameters:

location - location the check available bytes

Returns:

available bytes

getBlockMeta

public BlockMeta getBlockMeta(long blockId)
                       throws BlockDoesNotExistException

Gets the metadata of a block given its block id.

Parameters:

blockId - the block id

Returns:

metadata of the block

Throws:

BlockDoesNotExistException - if no BlockMeta for this block id is found

getBlockPath

@Nullable
public String getBlockPath(long blockId,
                                     BlockStoreLocation location)

Returns the path of a block given its location, or null if the location is not a specific StorageDir. Throws an IllegalArgumentException if the location is not a specific StorageDir.

Parameters:

blockId - the id of the block

location - location of a particular StorageDir to store this block

Returns:

the path of this block in this location, or null if the location is not available

getBlockStoreMeta

public BlockStoreMeta getBlockStoreMeta()

Gets a summary of the metadata.

Returns:

the metadata of this block store

getBlockStoreMetaFull

public BlockStoreMeta getBlockStoreMetaFull()

Gets a full summary of block store metadata. This is an expensive operation.

Returns:

the full metadata of this block store

getDir

public StorageDir getDir(BlockStoreLocation location)

Gets the StorageDir given its location in the store. Throws an IllegalArgumentException if the location is not a specific dir or the location is invalid.

Parameters:

location - Location of the dir

Returns:

the StorageDir object

getTempBlockMeta

public TempBlockMeta getTempBlockMeta(long blockId)
                               throws BlockDoesNotExistException

Gets the metadata of a temp block.

Parameters:

blockId - the id of the temp block

Returns:

metadata of the block

Throws:

BlockDoesNotExistException - when block id can not be found

getTempBlockMetaOrNull

@Nullable
public TempBlockMeta getTempBlockMetaOrNull(long blockId)

Gets the metadata of a temp block.

Parameters:

blockId - the id of the temp block

Returns:

metadata of the block or null

getTier

public StorageTier getTier(String tierAlias)

Gets the StorageTier given its tierAlias. Throws an IllegalArgumentException if the tierAlias is not found.

Parameters:

tierAlias - the alias of this tier

Returns:

the StorageTier object associated with the alias

getTiers

public List<StorageTier> getTiers()

Gets the list of StorageTier managed.

Returns:

the list of StorageTiers

getTiersBelow

public List<StorageTier> getTiersBelow(String tierAlias)

Gets the list of StorageTier below the tier with the given tierAlias. Throws an IllegalArgumentException if the tierAlias is not found.

Parameters:

tierAlias - the alias of a tier

Returns:

the list of StorageTier

getSessionTempBlocks

public List<TempBlockMeta> getSessionTempBlocks(long sessionId)

Gets all the temporary blocks associated with a session, empty list is returned if the session has no temporary blocks.

Parameters:

sessionId - the id of the session

Returns:

A list of temp blocks associated with the session

hasBlockMeta

public boolean hasBlockMeta(long blockId)

Checks if the storage has a given block.

Parameters:

blockId - the block id

Returns:

true if the block is contained, false otherwise

hasTempBlockMeta

public boolean hasTempBlockMeta(long blockId)

Checks if the storage has a given temp block.

Parameters:

blockId - the temp block id

Returns:

true if the block is contained, false otherwise

moveBlockMeta

public BlockMeta moveBlockMeta(BlockMeta blockMeta,
                               TempBlockMeta tempBlockMeta)
                        throws BlockDoesNotExistException,
                               WorkerOutOfSpaceException,
                               BlockAlreadyExistsException

Moves an existing block to another location currently hold by a temp block.

Parameters:

blockMeta - the metadata of the block to move

tempBlockMeta - a placeholder in the destination directory

Returns:

the new block metadata if success, absent otherwise

Throws:

BlockDoesNotExistException - when the block to move is not found

BlockAlreadyExistsException - when the block to move already exists in the destination

WorkerOutOfSpaceException - when destination have no extra space to hold the block to move

moveBlockMeta

@Deprecated
public BlockMeta moveBlockMeta(BlockMeta blockMeta,
                                           BlockStoreLocation newLocation)
                                    throws BlockDoesNotExistException,
                                           BlockAlreadyExistsException,
                                           WorkerOutOfSpaceException

Deprecated. As of version 0.8. Use moveBlockMeta(BlockMeta, TempBlockMeta) instead.

Moves the metadata of an existing block to another location or throws IOExceptions. Throws an IllegalArgumentException if the newLocation is not in the tiered storage.

Parameters:

blockMeta - the metadata of the block to move

newLocation - new location of the block

Returns:

the new block metadata if success, absent otherwise

Throws:

BlockDoesNotExistException - when the block to move is not found

BlockAlreadyExistsException - when the block to move already exists in the destination

WorkerOutOfSpaceException - when destination have no extra space to hold the block to move

removeBlockMeta

public void removeBlockMeta(BlockMeta block)
                     throws BlockDoesNotExistException

Removes the metadata of a specific block.

Parameters:

block - the metadata of the block to remove

Throws:

BlockDoesNotExistException - when block is not found

resizeTempBlockMeta

public void resizeTempBlockMeta(TempBlockMeta tempBlockMeta,
                                long newSize)
                         throws InvalidWorkerStateException

Modifies the size of a temp block.

Parameters:

tempBlockMeta - the temp block to modify

newSize - new size in bytes

Throws:

InvalidWorkerStateException - when newSize is smaller than current size

getStorageTierAssoc

public StorageTierAssoc getStorageTierAssoc()

Returns:

the storage tier mapping