tachyon.worker.hierarchy

Class StorageDir

java.lang.Object

tachyon.worker.hierarchy.StorageDir

public final class StorageDir
extends Object

Stores and manages block files in storage's directory in different storage systems.

Method Summary

Methods

Modifier and Type	Method and Description
void	accessBlock(long blockId) Update the last access time of the block
boolean	cacheBlock(long userId, long blockId) Move the cached block file from user temporary folder to data folder
boolean	cancelBlock(long userId, long blockId) Cancel a block which is being written
void	cleanUserResources(long userId, Collection<Long> tempBlockIdList) Clean resources related to the removed user
boolean	containsBlock(long blockId) Check whether the StorageDir contains certain block
boolean	copyBlock(long blockId, StorageDir dstDir) Copy block file from this StorageDir to another StorageDir, the caller needs to make sure the block is locked during copying
boolean	deleteBlock(long blockId) Remove a block from current StorageDir, once calling this method, the block will not be available any longer
List<Long>	getAddedBlockIdList() Get Ids of newly added blocks
long	getAvailableBytes() Get available space size in bytes in current StorageDir
ByteBuffer	getBlockData(long blockId, long offset, int length) Read data into ByteBuffer from some block file, caller needs to make sure the block is locked during reading
String	getBlockFilePath(long blockId) Get file path of the block file
BlockHandler	getBlockHandler(long blockId) Get block handler used to access the block file
Set<Long>	getBlockIds() Get Ids of the blocks in current StorageDir
long	getBlockSize(long blockId) Get size of the block in bytes
Set<Map.Entry<Long,Long>>	getBlockSizes() Get sizes of the blocks in bytes in current StorageDir
long	getCapacityBytes() Get capacity of current StorageDir in bytes
TachyonURI	getDirDataPath() Get data path of current StorageDir
TachyonURI	getDirPath() Get root path of current StorageDir
Set<Map.Entry<Long,Long>>	getLastBlockAccessTimeMs() Get last access time of blocks in current StorageDir
long	getLockedSizeBytes() Get size of locked blocks in bytes in current StorageDir
long	getStorageDirId() Get Id of current StorageDir
UnderFileSystem	getUfs() Get current StorageDir's under file system
Object	getUfsConf() Get configuration of current StorageDir's under file system
long	getUsedBytes() Get used space in bytes in current StorageDir
long	getUserOwnBytes(long userId) Get temporary space owned by the user in current StorageDir
String	getUserTempFilePath(long userId, long blockId) Get temporary file path of block written by some user
TachyonURI	getUserTempPath() Get root temporary path of users
String	getUserTempPath(long userId) Get temporary path of some user
void	initailize() Initialize current StorageDir
boolean	isBlockLocked(long blockId) Check whether certain block is locked
boolean	lockBlock(long blockId, long userId) Lock block by some user
boolean	moveBlock(long blockId, StorageDir dstDir) Move a block from its current StorageDir to another StorageDir
boolean	requestSpace(long userId, long size) Request space from current StorageDir by some user
void	returnSpace(long userId, long size) Return space to current StorageDir by some user
boolean	unlockBlock(long blockId, long userId) Unlock block by some user
void	updateTempBlockAllocatedBytes(long userId, long blockId, long sizeBytes) Update allocated space bytes of a temporary block in current StorageDir

Methods inherited from class java.lang.Object

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

Method Detail

accessBlock

public void accessBlock(long blockId)

Update the last access time of the block

Parameters:

blockId - Id of the block

cacheBlock

public boolean cacheBlock(long userId,
                 long blockId)
                   throws IOException

Move the cached block file from user temporary folder to data folder

Parameters:

userId - the id of the user

blockId - the id of the block

Returns:

true if success, false otherwise

Throws:

IOException

cancelBlock

public boolean cancelBlock(long userId,
                  long blockId)
                    throws IOException

Cancel a block which is being written

Parameters:

userId - the id of the user

blockId - the id of the block to be cancelled

Returns:

true if success, false otherwise

Throws:

IOException

cleanUserResources

public void cleanUserResources(long userId,
                      Collection<Long> tempBlockIdList)

Clean resources related to the removed user

Parameters:

userId - id of the removed user

tempBlockIdList - list of block ids that are being written by the user

containsBlock

public boolean containsBlock(long blockId)

Check whether the StorageDir contains certain block

Parameters:

blockId - Id of the block

Returns:

true if StorageDir contains the block, false otherwise

copyBlock

public boolean copyBlock(long blockId,
                StorageDir dstDir)
                  throws IOException

Copy block file from this StorageDir to another StorageDir, the caller needs to make sure the block is locked during copying

Parameters:

blockId - Id of the block

dstDir - destination StorageDir

Returns:

true if success, false otherwise

Throws:

IOException

deleteBlock

public boolean deleteBlock(long blockId)
                    throws IOException

Remove a block from current StorageDir, once calling this method, the block will not be available any longer

Parameters:

blockId - Id of the block to be removed.

Returns:

true if succeed, false otherwise

Throws:

IOException

getAddedBlockIdList

public List<Long> getAddedBlockIdList()

Get Ids of newly added blocks

Returns:

list of added block Ids

getAvailableBytes

public long getAvailableBytes()

Get available space size in bytes in current StorageDir

Returns:

available space size in current StorageDir

getBlockData

public ByteBuffer getBlockData(long blockId,
                      long offset,
                      int length)
                        throws IOException

Read data into ByteBuffer from some block file, caller needs to make sure the block is locked during reading

Parameters:

blockId - Id of the block

offset - starting position of the block file

length - length of data to read

Returns:

ByteBuffer which contains data of the block

Throws:

IOException

getBlockFilePath

public String getBlockFilePath(long blockId)

Get file path of the block file

Parameters:

blockId - Id of the block

Returns:

file path of the block

getBlockHandler

public BlockHandler getBlockHandler(long blockId)
                             throws IOException

Get block handler used to access the block file

Parameters:

blockId - Id of the block

Returns:

block handler of the block file

Throws:

IOException

getBlockIds

public Set<Long> getBlockIds()

Get Ids of the blocks in current StorageDir

Returns:

Ids of the blocks in current StorageDir

getBlockSize

public long getBlockSize(long blockId)

Get size of the block in bytes

Parameters:

blockId - Id of the block

Returns:

size of the block, -1 if block doesn't exist

getBlockSizes

public Set<Map.Entry<Long,Long>> getBlockSizes()

Get sizes of the blocks in bytes in current StorageDir

Returns:

set of map entry mapping from block Id to the block size in current StorageDir

getCapacityBytes

public long getCapacityBytes()

Get capacity of current StorageDir in bytes

Returns:

capacity of current StorageDir in bytes

getDirDataPath

public TachyonURI getDirDataPath()

Get data path of current StorageDir

Returns:

data path of current StorageDir

getDirPath

public TachyonURI getDirPath()

Get root path of current StorageDir

Returns:

root path of StorageDir

getLastBlockAccessTimeMs

public Set<Map.Entry<Long,Long>> getLastBlockAccessTimeMs()

Get last access time of blocks in current StorageDir

Returns:

set of map entry mapping from block Id to its last access time in current StorageDir

getLockedSizeBytes

public long getLockedSizeBytes()

Get size of locked blocks in bytes in current StorageDir

Returns:

size of locked blocks in bytes in current StorageDir

getStorageDirId

public long getStorageDirId()

Get Id of current StorageDir

Returns:

Id of current StorageDir

getUfs

public UnderFileSystem getUfs()

Get current StorageDir's under file system

Returns:

StorageDir's under file system

getUfsConf

public Object getUfsConf()

Get configuration of current StorageDir's under file system

Returns:

configuration of the under file system

getUsedBytes

public long getUsedBytes()

Get used space in bytes in current StorageDir

Returns:

used space in bytes in current StorageDir

getUserOwnBytes

public long getUserOwnBytes(long userId)

Get temporary space owned by the user in current StorageDir

Returns:

temporary space in bytes owned by the user in current StorageDir

getUserTempFilePath

public String getUserTempFilePath(long userId,
                         long blockId)

Get temporary file path of block written by some user

Parameters:

userId - Id of the user

blockId - Id of the block

Returns:

temporary file path of the block

getUserTempPath

public TachyonURI getUserTempPath()

Get root temporary path of users

Returns:

TachyonURI of users' temporary path

getUserTempPath

public String getUserTempPath(long userId)

Get temporary path of some user

Parameters:

userId - Id of the user

Returns:

temporary path of the user

initailize

public void initailize()
                throws IOException

Initialize current StorageDir

Throws:

IOException

isBlockLocked

public boolean isBlockLocked(long blockId)

Check whether certain block is locked

Parameters:

blockId - Id of the block

Returns:

true if block is locked, false otherwise

lockBlock

public boolean lockBlock(long blockId,
                long userId)

Lock block by some user

Parameters:

blockId - Id of the block

userId - Id of the user

Returns:

true if success, false otherwise

moveBlock

public boolean moveBlock(long blockId,
                StorageDir dstDir)
                  throws IOException

Move a block from its current StorageDir to another StorageDir

Parameters:

blockId - the id of the block

dstDir - the destination StorageDir

Returns:

true if success, false otherwise

Throws:

IOException

requestSpace

public boolean requestSpace(long userId,
                   long size)

Request space from current StorageDir by some user

Parameters:

userId - Id of the user

size - request size in bytes

Returns:

true if success, false otherwise

returnSpace

public void returnSpace(long userId,
               long size)

Return space to current StorageDir by some user

Parameters:

userId - Id of the user

size - size to return in bytes

unlockBlock

public boolean unlockBlock(long blockId,
                  long userId)

Unlock block by some user

Parameters:

blockId - Id of the block

userId - Id of the user

Returns:

true if success, false otherwise

updateTempBlockAllocatedBytes

public void updateTempBlockAllocatedBytes(long userId,
                                 long blockId,
                                 long sizeBytes)

Update allocated space bytes of a temporary block in current StorageDir

Parameters:

userId - Id of the user

blockId - Id of the block

sizeBytes - updated space size in bytes