tachyon.master

Class InodeFile

java.lang.Object

tachyon.master.ImageWriter

tachyon.master.Inode

tachyon.master.InodeFile

All Implemented Interfaces:

Comparable<Inode>

public class InodeFile
extends Inode

Tachyon file system's file representation in master.

Field Summary

Fields inherited from class tachyon.master.Inode

mIsFolder

Constructor Summary

Constructors

Constructor and Description
InodeFile(String name, int id, int parentId, long blockSizeByte, long creationTimeMs) Create a new InodeFile.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBlock(BlockInfo blockInfo) Add a block to the file.It will check the legality.
void	addLocation(int blockIndex, long workerId, NetAddress workerAddress, long storageDirId) Add a location information of the file.
ClientFileInfo	generateClientFileInfo(String path) Generate a ClientFileInfo of the file or folder.
long	getBlockIdBasedOnOffset(long offset) Get the id of the specified block by the offset of the file.
List<Long>	getBlockIds() Get all the blocks of the file.
List<Pair<Long,Long>>	getBlockIdWorkerIdPairs() The pairs of the blocks and workers.
List<BlockInfo>	getBlockList() Get the block list of the file, which is not a duplication.
List<NetAddress>	getBlockLocations(int blockIndex) Get the locations of the specified block.
long	getBlockSizeByte() Get the block size of the file
ClientBlockInfo	getClientBlockInfo(int blockIndex) Get a ClientBlockInfo of the specified block.
List<ClientBlockInfo>	getClientBlockInfos() Get file's all blocks' ClientBlockInfo information.
int	getDependencyId() Get the dependency id of the file
long	getLength() Get the length of the file
long	getNewBlockId() Get the id of a new block of the file.
int	getNumberOfBlocks() Get the number of the blocks of the file
String	getUfsPath() Get the path of the file in under file system
boolean	hasCheckpointed() Return whether the file has checkpointed or not.
boolean	isCache() Return whether the file is cacheable or not.
boolean	isComplete() Return whether the file is complete or not.
boolean	isFullyInMemory() Return whether the file is fully in memory or not.
void	removeLocation(int blockIndex, long workerId) Remove a location of a block.
void	setCache(boolean cache) Set whether the file is cacheable or not.
void	setComplete() The file is complete.
void	setComplete(boolean complete) Set the complete flag of the file
void	setDependencyId(int dependencyId) Set the dependency id of the file
void	setLength(long length) Set the length of the file.
void	setUfsPath(String ufsPath) Set the path of the file in under file system.
String	toString()
void	writeImage(com.fasterxml.jackson.databind.ObjectWriter objWriter, DataOutputStream dos) Write image to the specified DataOutputStream.

Methods inherited from class tachyon.master.Inode

compareTo, equals, getCreationTimeMs, getId, getLastModificationTimeMs, getName, getParentId, hashCode, isDirectory, isFile, isPinned, reverseId, setLastModificationTimeMs, setName, setParentId, setPinned

Methods inherited from class tachyon.master.ImageWriter

writeElement

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InodeFile

public InodeFile(String name,
         int id,
         int parentId,
         long blockSizeByte,
         long creationTimeMs)

Create a new InodeFile.

Parameters:

name - The name of the file

id - The id of the file

parentId - The id of the parent of the file

blockSizeByte - The block size of the file, in bytes

creationTimeMs - The creation time of the file, in milliseconds

Method Detail

addBlock

public void addBlock(BlockInfo blockInfo)
              throws BlockInfoException

Add a block to the file.It will check the legality. Cannot add the block if the file is complete or the block's information doesn't match the file's information.

Parameters:

blockInfo - The block to be added

Throws:

BlockInfoException

addLocation

public void addLocation(int blockIndex,
               long workerId,
               NetAddress workerAddress,
               long storageDirId)
                 throws BlockInfoException

Add a location information of the file. A worker caches a block of the file.

Parameters:

blockIndex - The index of the block in the file

workerId - The id of the worker

workerAddress - The net address of the worker

storageDirId - The id of the StorageDir which block is located in

Throws:

BlockInfoException

generateClientFileInfo

public ClientFileInfo generateClientFileInfo(String path)

Description copied from class: Inode

Generate a ClientFileInfo of the file or folder.

Specified by:

generateClientFileInfo in class Inode

Parameters:

path - The path of the file

Returns:

generated ClientFileInfo

getBlockIdBasedOnOffset

public long getBlockIdBasedOnOffset(long offset)

Get the id of the specified block by the offset of the file.

Parameters:

offset - The offset of the file

Returns:

the id of the specified block

getBlockIds

public List<Long> getBlockIds()

Get all the blocks of the file. It will return a duplication.

Returns:

a duplication of all the blocks' ids of the file

getBlockIdWorkerIdPairs

public List<Pair<Long,Long>> getBlockIdWorkerIdPairs()

The pairs of the blocks and workers. Each pair contains a block's id and the id of the worker who caches it.

Returns:

all the pairs of the blocks and the workers

getBlockList

public List<BlockInfo> getBlockList()

Get the block list of the file, which is not a duplication.

Returns:

the block list of the file

getBlockLocations

public List<NetAddress> getBlockLocations(int blockIndex)
                                   throws BlockInfoException

Get the locations of the specified block.

Parameters:

blockIndex - The index of the block in the file

Returns:

a list of the worker's net address who caches the block

Throws:

BlockInfoException

getBlockSizeByte

public long getBlockSizeByte()

Get the block size of the file

Returns:

the block size in bytes

getUfsPath

public String getUfsPath()

Get the path of the file in under file system

Returns:

the path of the file in under file system

getClientBlockInfo

public ClientBlockInfo getClientBlockInfo(int blockIndex)
                                   throws BlockInfoException

Get a ClientBlockInfo of the specified block.

Parameters:

blockIndex - The index of the block in the file

Returns:

the generated ClientBlockInfo

Throws:

BlockInfoException

getClientBlockInfos

public List<ClientBlockInfo> getClientBlockInfos()

Get file's all blocks' ClientBlockInfo information.

Returns:

all blocks ClientBlockInfo

getDependencyId

public int getDependencyId()

Get the dependency id of the file

Returns:

the dependency id of the file

getLength

public long getLength()

Get the length of the file

Returns:

the length of the file

getNewBlockId

public long getNewBlockId()

Get the id of a new block of the file. Also the id of the next block added into the file.

Returns:

the id of a new block of the file

getNumberOfBlocks

public int getNumberOfBlocks()

Get the number of the blocks of the file

Returns:

the number of the blocks

hasCheckpointed

public boolean hasCheckpointed()

Return whether the file has checkpointed or not. Note that the file has checkpointed only if the under file system path is not empty.

Returns:

true if the file has checkpointed, false otherwise

isCache

public boolean isCache()

Return whether the file is cacheable or not.

Returns:

true if the file is cacheable, false otherwise

isComplete

public boolean isComplete()

Return whether the file is complete or not.

Returns:

true if the file is complete, false otherwise

isFullyInMemory

public boolean isFullyInMemory()

Return whether the file is fully in memory or not. The file is fully in memory only if all the blocks of the file are in memory, in other words, the in memory percentage is 100.

Returns:

true if the file is fully in memory, false otherwise

removeLocation

public void removeLocation(int blockIndex,
                  long workerId)
                    throws BlockInfoException

Remove a location of a block.

Parameters:

blockIndex - The index of the block in the file

workerId - The id of the removed location worker

Throws:

BlockInfoException

setCache

public void setCache(boolean cache)

Set whether the file is cacheable or not.

Parameters:

cache - If true, the file is cacheable

setUfsPath

public void setUfsPath(String ufsPath)

Set the path of the file in under file system.

Parameters:

ufsPath - The new path of the file in under file system

setComplete

public void setComplete()

The file is complete. Set the complete flag true.

setComplete

public void setComplete(boolean complete)

Set the complete flag of the file

Parameters:

complete - If true, the file is complete

setDependencyId

public void setDependencyId(int dependencyId)

Set the dependency id of the file

Parameters:

dependencyId - The new dependency id of the file

setLength

public void setLength(long length)
               throws SuspectedFileSizeException,
                      BlockInfoException

Set the length of the file. Cannot set the length if the file is complete or the length is negative.

Parameters:

length - The new length of the file, cannot be negative

Throws:

SuspectedFileSizeException

BlockInfoException

toString

public String toString()

Overrides:

toString in class Inode

writeImage

public void writeImage(com.fasterxml.jackson.databind.ObjectWriter objWriter,
              DataOutputStream dos)
                throws IOException

Description copied from class: ImageWriter

Write image to the specified DataOutputStream. Use the specified ObjectWriter.

Parameters:

objWriter - The used object writer

dos - The target data output stream

Throws:

IOException