alluxio.worker.block.meta

Class DefaultStorageDir

java.lang.Object

alluxio.worker.block.meta.DefaultStorageDir

All Implemented Interfaces:

StorageDir

@NotThreadSafe
public final class DefaultStorageDir
extends Object
implements StorageDir

Represents a directory in a storage tier. It has a fixed capacity allocated to it on instantiation. It contains the set of blocks currently in the storage directory. Portion of capacity will be accounted as reserved space. Through StorageDirView, this space will be reflected as: - committed for user I/Os - available for internal I/Os.

Method Summary

Modifier and Type	Method and Description
void	addBlockMeta(BlockMeta blockMeta) Adds the metadata of a new block into this storage dir.
void	addTempBlockMeta(TempBlockMeta tempBlockMeta) Adds the metadata of a new block into this storage dir.
void	cleanupSessionTempBlocks(long sessionId, List<Long> tempBlockIds) Cleans up the temp block metadata for each block id passed in.
long	getAvailableBytes() Gets the total available capacity of this StorageDir in bytes.
List<Long>	getBlockIds() Returns the list of block ids in this dir.
BlockMeta	getBlockMeta(long blockId) Gets the BlockMeta from this storage dir by its block id.
List<BlockMeta>	getBlocks() Returns the list of blocks stored in this dir.
long	getCapacityBytes() Gets the total capacity of this StorageDir in bytes, which is a constant once this StorageDir has been initialized.
long	getCommittedBytes() Gets the total size of committed blocks in this StorageDir in bytes.
int	getDirIndex() Returns the zero-based index of this dir in its parent StorageTier.
String	getDirMedium()
String	getDirPath()
StorageTier	getParentTier() Returns the StorageTier containing this StorageDir.
long	getReservedBytes()
List<TempBlockMeta>	getSessionTempBlocks(long sessionId) Gets the temporary blocks associated with a session in this StorageDir, an empty list is returned if the session has no temporary blocks in this StorageDir.
TempBlockMeta	getTempBlockMeta(long blockId) Gets the TempBlockMeta from this storage dir by its block id.
boolean	hasBlockMeta(long blockId) Checks if a block is in this storage dir.
boolean	hasTempBlockMeta(long blockId) Checks if a temp block is in this storage dir.
static StorageDir	newStorageDir(StorageTier tier, int dirIndex, long capacityBytes, long reservedBytes, String dirPath, String dirMedium) Factory method to create StorageDir.
void	removeBlockMeta(BlockMeta blockMeta) Removes a block from this storage dir.
void	removeTempBlockMeta(TempBlockMeta tempBlockMeta) Removes a temp block from this storage dir.
void	resizeTempBlockMeta(TempBlockMeta tempBlockMeta, long newSize) Changes the size of a temp block.
BlockStoreLocation	toBlockStoreLocation()

Methods inherited from class java.lang.Object

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

Method Detail

newStorageDir

public static StorageDir newStorageDir(StorageTier tier,
                                       int dirIndex,
                                       long capacityBytes,
                                       long reservedBytes,
                                       String dirPath,
                                       String dirMedium)
                                throws BlockAlreadyExistsException,
                                       IOException,
                                       WorkerOutOfSpaceException,
                                       InvalidPathException

Factory method to create StorageDir. It will load metadata of existing committed blocks in the dirPath specified. Only files with directory depth 1 under dirPath and whose file name can be parsed into long will be considered as existing committed blocks, these files will be preserved, others files or directories will be deleted.

Parameters:

tier - the StorageTier this dir belongs to

dirIndex - the index of this dir in its tier

capacityBytes - the initial capacity of this dir, can not be modified later

reservedBytes - the amount of reserved space for internal management

dirPath - filesystem path of this dir for actual storage

dirMedium - the medium type of the storage dir

Returns:

the new created StorageDir

Throws:

BlockAlreadyExistsException - when metadata of existing committed blocks already exists

WorkerOutOfSpaceException - when metadata can not be added due to limited left space

IOException

InvalidPathException

getCapacityBytes

public long getCapacityBytes()

Description copied from interface: StorageDir

Gets the total capacity of this StorageDir in bytes, which is a constant once this StorageDir has been initialized.

Specified by:

getCapacityBytes in interface StorageDir

Returns:

the total capacity of this StorageDir in bytes

getAvailableBytes

public long getAvailableBytes()

Description copied from interface: StorageDir

Gets the total available capacity of this StorageDir in bytes. This value equals the total capacity of this StorageDir, minus the used bytes by committed blocks and temp blocks.

Specified by:

getAvailableBytes in interface StorageDir

Returns:

available capacity in bytes

getCommittedBytes

public long getCommittedBytes()

Description copied from interface: StorageDir

Gets the total size of committed blocks in this StorageDir in bytes.

Specified by:

getCommittedBytes in interface StorageDir

Returns:

number of committed bytes

getDirPath

public String getDirPath()

Specified by:

getDirPath in interface StorageDir

Returns:

the path of the directory

getDirMedium

public String getDirMedium()

Specified by:

getDirMedium in interface StorageDir

Returns:

the medium of the storage dir

getParentTier

public StorageTier getParentTier()

Description copied from interface: StorageDir

Returns the StorageTier containing this StorageDir.

Specified by:

getParentTier in interface StorageDir

Returns:

StorageTier

getDirIndex

public int getDirIndex()

Description copied from interface: StorageDir

Returns the zero-based index of this dir in its parent StorageTier.

Specified by:

getDirIndex in interface StorageDir

Returns:

index

getBlockIds

public List<Long> getBlockIds()

Description copied from interface: StorageDir

Returns the list of block ids in this dir.

Specified by:

getBlockIds in interface StorageDir

Returns:

a list of block ids

getBlocks

public List<BlockMeta> getBlocks()

Description copied from interface: StorageDir

Returns the list of blocks stored in this dir.

Specified by:

getBlocks in interface StorageDir

Returns:

a list of blocks

hasBlockMeta

public boolean hasBlockMeta(long blockId)

Description copied from interface: StorageDir

Checks if a block is in this storage dir.

Specified by:

hasBlockMeta in interface StorageDir

Parameters:

blockId - the block id

Returns:

true if the block is in this storage dir, false otherwise

hasTempBlockMeta

public boolean hasTempBlockMeta(long blockId)

Description copied from interface: StorageDir

Checks if a temp block is in this storage dir.

Specified by:

hasTempBlockMeta in interface StorageDir

Parameters:

blockId - the block id

Returns:

true if the block is in this storage dir, false otherwise

getBlockMeta

public BlockMeta getBlockMeta(long blockId)
                       throws BlockDoesNotExistException

Description copied from interface: StorageDir

Gets the BlockMeta from this storage dir by its block id.

Specified by:

getBlockMeta in interface StorageDir

Parameters:

blockId - the block id

Returns:

BlockMeta of the given block or null

Throws:

BlockDoesNotExistException - if no block is found

getTempBlockMeta

public TempBlockMeta getTempBlockMeta(long blockId)

Description copied from interface: StorageDir

Gets the TempBlockMeta from this storage dir by its block id.

Specified by:

getTempBlockMeta in interface StorageDir

Parameters:

blockId - the block id

Returns:

TempBlockMeta of the given block or null

addBlockMeta

public void addBlockMeta(BlockMeta blockMeta)
                  throws WorkerOutOfSpaceException,
                         BlockAlreadyExistsException

Description copied from interface: StorageDir

Adds the metadata of a new block into this storage dir.

Specified by:

addBlockMeta in interface StorageDir

Parameters:

blockMeta - the metadata of the block

Throws:

WorkerOutOfSpaceException - when not enough space to hold block

BlockAlreadyExistsException - if blockId already exists

addTempBlockMeta

public void addTempBlockMeta(TempBlockMeta tempBlockMeta)
                      throws WorkerOutOfSpaceException,
                             BlockAlreadyExistsException

Description copied from interface: StorageDir

Adds the metadata of a new block into this storage dir.

Specified by:

addTempBlockMeta in interface StorageDir

Parameters:

tempBlockMeta - the metadata of a temp block to add

Throws:

WorkerOutOfSpaceException - when not enough space to hold block

BlockAlreadyExistsException - if blockId already exists

removeBlockMeta

public void removeBlockMeta(BlockMeta blockMeta)
                     throws BlockDoesNotExistException

Description copied from interface: StorageDir

Removes a block from this storage dir.

Specified by:

removeBlockMeta in interface StorageDir

Parameters:

blockMeta - the metadata of the block

Throws:

BlockDoesNotExistException - if no block is found

removeTempBlockMeta

public void removeTempBlockMeta(TempBlockMeta tempBlockMeta)
                         throws BlockDoesNotExistException

Description copied from interface: StorageDir

Removes a temp block from this storage dir.

Specified by:

removeTempBlockMeta in interface StorageDir

Parameters:

tempBlockMeta - the metadata of the temp block to remove

Throws:

BlockDoesNotExistException - if no temp block is found

resizeTempBlockMeta

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

Description copied from interface: StorageDir

Changes the size of a temp block.

Specified by:

resizeTempBlockMeta in interface StorageDir

Parameters:

tempBlockMeta - the metadata of the temp block to resize

newSize - the new size after change in bytes

Throws:

InvalidWorkerStateException - when newSize is smaller than oldSize

cleanupSessionTempBlocks

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

Description copied from interface: StorageDir

Cleans up the temp block metadata for each block id passed in.

Specified by:

cleanupSessionTempBlocks in interface StorageDir

Parameters:

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

tempBlockIds - the list of temporary blocks to clean up, non temporary blocks or nonexistent blocks will be ignored

getSessionTempBlocks

public List<TempBlockMeta> getSessionTempBlocks(long sessionId)

Description copied from interface: StorageDir

Gets the temporary blocks associated with a session in this StorageDir, an empty list is returned if the session has no temporary blocks in this StorageDir.

Specified by:

getSessionTempBlocks in interface StorageDir

Parameters:

sessionId - the id of the session

Returns:

A list of temporary blocks the session is associated with in this StorageDir

toBlockStoreLocation

public BlockStoreLocation toBlockStoreLocation()

Specified by:

toBlockStoreLocation in interface StorageDir

Returns:

the block store location of this directory

getReservedBytes

public long getReservedBytes()

Specified by:

getReservedBytes in interface StorageDir

Returns:

amount of reserved bytes for this dir