alluxio.worker.block

Interface BlockWorker

All Superinterfaces:

Server<WorkerNetAddress>, SessionCleanable, Worker

All Known Implementing Classes:

DefaultBlockWorker

public interface BlockWorker
extends Worker, SessionCleanable

A block worker in the Alluxio system.

Field Summary

Fields

Modifier and Type	Field and Description
static long	INVALID_LOCK_ID Invalid lock ID.

Method Summary

Modifier and Type	Method and Description
void	abortBlock(long sessionId, long blockId) Aborts the temporary block created by the session.
void	accessBlock(long sessionId, long blockId) Access the block for a given session.
void	asyncCache(AsyncCacheRequest request) Deprecated. This method will be deprecated as of v3.0, use cache
void	cache(CacheRequest request) Submits the cache request to cache manager to execute.
void	clearMetrics() Clears the worker metrics.
void	commitBlock(long sessionId, long blockId, boolean pinOnCreate) Commits a block to Alluxio managed space.
void	commitBlockInUfs(long blockId, long length) Commits a block in UFS.
String	createBlock(long sessionId, long blockId, int tier, String medium, long initialBytes) Creates a block in Alluxio managed space.
BlockReader	createBlockReader(BlockReadRequest request) Creates the block reader to read from Alluxio block or UFS block.
BlockWriter	createBlockWriter(long sessionId, long blockId) Creates a BlockWriter for an existing temporary block which is already created by createBlock(long, long, int, java.lang.String, long).
BlockReader	createUfsBlockReader(long sessionId, long blockId, long offset, boolean positionShort, Protocol.OpenUfsBlockOptions options) Creates a block reader to read a UFS block starting from given block offset.
BlockMeta	getBlockMeta(long sessionId, long blockId, long lockId) Gets the metadata of a specific block from local storage.
Configuration	getConfiguration(GetConfigurationPOptions options)
FileInfo	getFileInfo(long fileId) Gets the file information.
BlockHeartbeatReport	getReport() Gets a report for the periodic heartbeat to master.
BlockStoreMeta	getStoreMeta() Gets the metadata for the entire block store.
BlockStoreMeta	getStoreMetaFull() Similar as getStoreMeta() except that this also contains full blockId list.
TempBlockMeta	getTempBlockMeta(long sessionId, long blockId)
BlockMeta	getVolatileBlockMeta(long blockId) Gets the metadata of a block given its blockId or throws IOException.
List<String>	getWhiteList()
AtomicReference<Long>	getWorkerId()
boolean	hasBlockMeta(long blockId) Checks if the storage has a given block.
long	lockBlock(long sessionId, long blockId) Obtains a read lock on a block.
void	moveBlock(long sessionId, long blockId, int tier) Moves a block from its current location to a target location, currently only tier level moves are supported.
void	moveBlockToMedium(long sessionId, long blockId, String mediumType) Moves a block from its current location to a target location, with a specific medium type.
void	removeBlock(long sessionId, long blockId) Frees a block from Alluxio managed space.
void	requestSpace(long sessionId, long blockId, long additionalBytes) Request an amount of space for a block in its storage directory.
void	unlockBlock(long lockId) Releases the lock with the specified lock id.
void	updatePinList(Set<Long> pinnedInodes) Sets the pinlist for the underlying block store.

Methods inherited from interface alluxio.Server

close, getDependencies, getName, getServices, start, stop

Methods inherited from interface alluxio.worker.SessionCleanable

cleanupSession

Field Detail

INVALID_LOCK_ID

static final long INVALID_LOCK_ID

Invalid lock ID.

See Also:

Constant Field Values

Method Detail

getWorkerId

AtomicReference<Long> getWorkerId()

Returns:

the worker id

abortBlock

void abortBlock(long sessionId,
                long blockId)
         throws BlockAlreadyExistsException,
                BlockDoesNotExistException,
                InvalidWorkerStateException,
                IOException

Aborts the temporary block created by the session.

Parameters:

sessionId - the id of the client

blockId - the id of the block to be aborted

Throws:

BlockAlreadyExistsException - if blockId already exists in committed blocks

BlockDoesNotExistException - if the temporary block cannot be found

InvalidWorkerStateException - if blockId does not belong to sessionId

IOException

accessBlock

void accessBlock(long sessionId,
                 long blockId)
          throws BlockDoesNotExistException

Access the block for a given session. This should be called to update the evictor when necessary.

Parameters:

sessionId - the id of the client

blockId - the id of the block to access

Throws:

BlockDoesNotExistException - this exception is not thrown in the tiered block store implementation

commitBlock

void commitBlock(long sessionId,
                 long blockId,
                 boolean pinOnCreate)
          throws BlockAlreadyExistsException,
                 BlockDoesNotExistException,
                 InvalidWorkerStateException,
                 IOException,
                 WorkerOutOfSpaceException

Commits a block to Alluxio managed space. The block must be temporary. The block will not be persisted or accessible before commitBlock succeeds.

Parameters:

sessionId - the id of the client

blockId - the id of the block to commit

pinOnCreate - whether to pin block on create

Throws:

BlockAlreadyExistsException - if blockId already exists in committed blocks

BlockDoesNotExistException - if the temporary block cannot be found

InvalidWorkerStateException - if blockId does not belong to sessionId

WorkerOutOfSpaceException - if there is no more space left to hold the block

IOException

commitBlockInUfs

void commitBlockInUfs(long blockId,
                      long length)
               throws IOException

Commits a block in UFS.

Parameters:

blockId - the id of the block to commit

length - length of the block to commit

Throws:

IOException

createBlock

String createBlock(long sessionId,
                   long blockId,
                   int tier,
                   String medium,
                   long initialBytes)
            throws BlockAlreadyExistsException,
                   WorkerOutOfSpaceException,
                   IOException

Creates a block in Alluxio managed space. Calls createBlockWriter(long, long) to get a writer for writing to the block. The block will be temporary until it is committed by commitBlock(long, long, boolean) . Throws an IllegalArgumentException if the location does not belong to tiered storage.

Parameters:

sessionId - the id of the client

blockId - the id of the block to create

tier - the tier to place the new block in BlockStoreLocation.ANY_TIER for any tier

medium - the name of the medium to place the new block in

initialBytes - the initial amount of bytes to be allocated

Returns:

a string representing the path to the local file

Throws:

BlockAlreadyExistsException - if blockId already exists, either temporary or committed, or block in eviction plan already exists

WorkerOutOfSpaceException - if this Store has no more space than the initialBlockSize

IOException

getTempBlockMeta

@Nullable
TempBlockMeta getTempBlockMeta(long sessionId,
                                         long blockId)

Parameters:

sessionId - the id of the session to get this file

blockId - the id of the block

Returns:

metadata of the block or null if the temp block does not exist

createBlockWriter

BlockWriter createBlockWriter(long sessionId,
                              long blockId)
                       throws BlockDoesNotExistException,
                              BlockAlreadyExistsException,
                              InvalidWorkerStateException,
                              IOException

Creates a BlockWriter for an existing temporary block which is already created by createBlock(long, long, int, java.lang.String, long).

Parameters:

sessionId - the id of the client

blockId - the id of the block to be opened for writing

Returns:

the block writer for the local block file

Throws:

BlockDoesNotExistException - if the block cannot be found

BlockAlreadyExistsException - if a committed block with the same ID exists

InvalidWorkerStateException - if the worker state is invalid

IOException

getReport

BlockHeartbeatReport getReport()

Gets a report for the periodic heartbeat to master. Contains the blocks added since the last heart beat and blocks removed since the last heartbeat.

Returns:

a block heartbeat report

getStoreMeta

BlockStoreMeta getStoreMeta()

Gets the metadata for the entire block store. Contains the block mapping per storage dir and the total capacity and used capacity of each tier. This function is cheap.

Returns:

the block store metadata

getStoreMetaFull

BlockStoreMeta getStoreMetaFull()

Similar as getStoreMeta() except that this also contains full blockId list. This function is expensive.

Returns:

the full block store metadata

getVolatileBlockMeta

BlockMeta getVolatileBlockMeta(long blockId)
                        throws BlockDoesNotExistException

Gets the metadata of a block given its blockId or throws IOException. This method does not require a lock id so the block is possible to be moved or removed after it returns.

Parameters:

blockId - the block id

Returns:

metadata of the block

Throws:

BlockDoesNotExistException - if no BlockMeta for this blockId is found

getBlockMeta

BlockMeta getBlockMeta(long sessionId,
                       long blockId,
                       long lockId)
                throws BlockDoesNotExistException,
                       InvalidWorkerStateException

Gets the metadata of a specific block from local storage.

Unlike getVolatileBlockMeta(long), this method requires the lock id returned by a previously acquired lockBlock(long, long).

Parameters:

sessionId - the id of the session to get this file

blockId - the id of the block

lockId - the id of the lock

Returns:

metadata of the block

Throws:

BlockDoesNotExistException - if the block id can not be found in committed blocks or lockId can not be found

InvalidWorkerStateException - if session id or block id is not the same as that in the LockRecord of lockId

hasBlockMeta

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

lockBlock

long lockBlock(long sessionId,
               long blockId)

Obtains a read lock on a block. If lock is not acquired successfully, return INVALID_LOCK_ID.

Parameters:

sessionId - the id of the client

blockId - the id of the block to be locked

Returns:

the lock id that uniquely identifies the lock obtained or INVALID_LOCK_ID if it failed to lock

moveBlock

void moveBlock(long sessionId,
               long blockId,
               int tier)
        throws BlockDoesNotExistException,
               BlockAlreadyExistsException,
               InvalidWorkerStateException,
               WorkerOutOfSpaceException,
               IOException

Moves a block from its current location to a target location, currently only tier level moves are supported. Throws an IllegalArgumentException if the tierAlias is out of range of tiered storage.

Parameters:

sessionId - the id of the client

blockId - the id of the block to move

tier - the tier to move the block to

Throws:

BlockDoesNotExistException - if blockId cannot be found

BlockAlreadyExistsException - if blockId already exists in committed blocks of the newLocation

InvalidWorkerStateException - if blockId has not been committed

WorkerOutOfSpaceException - if newLocation does not have enough extra space to hold the block

IOException

moveBlockToMedium

void moveBlockToMedium(long sessionId,
                       long blockId,
                       String mediumType)
                throws BlockDoesNotExistException,
                       BlockAlreadyExistsException,
                       InvalidWorkerStateException,
                       WorkerOutOfSpaceException,
                       IOException

Moves a block from its current location to a target location, with a specific medium type. Throws an IllegalArgumentException if the medium type is not one of the listed medium types.

Parameters:

sessionId - the id of the client

blockId - the id of the block to move

mediumType - the medium type to move to

Throws:

BlockDoesNotExistException - if blockId cannot be found

BlockAlreadyExistsException - if blockId already exists in committed blocks of the newLocation

InvalidWorkerStateException - if blockId has not been committed

WorkerOutOfSpaceException - if newLocation does not have enough extra space to hold the block

IOException

createBlockReader

BlockReader createBlockReader(BlockReadRequest request)
                       throws BlockDoesNotExistException,
                              IOException

Creates the block reader to read from Alluxio block or UFS block. Owner of this block reader must close it or lock will leak.

Parameters:

request - the block read request

Returns:

a block reader to read data from

Throws:

BlockDoesNotExistException - if the requested block does not exist in this worker

IOException - if it fails to get block reader

createUfsBlockReader

BlockReader createUfsBlockReader(long sessionId,
                                 long blockId,
                                 long offset,
                                 boolean positionShort,
                                 Protocol.OpenUfsBlockOptions options)
                          throws BlockDoesNotExistException,
                                 IOException

Creates a block reader to read a UFS block starting from given block offset. Owner of this block reader must close it to cleanup state.

Parameters:

sessionId - the client session ID

blockId - the ID of the UFS block to read

offset - the offset within the block

positionShort - whether the operation is using positioned read to a small buffer size

options - the options

Returns:

the block reader instance

Throws:

BlockDoesNotExistException - if the block does not exist in the UFS block store

IOException

removeBlock

void removeBlock(long sessionId,
                 long blockId)
          throws InvalidWorkerStateException,
                 BlockDoesNotExistException,
                 IOException

Frees a block from Alluxio managed space.

Parameters:

sessionId - the id of the client

blockId - the id of the block to be freed

Throws:

InvalidWorkerStateException - if blockId has not been committed

BlockDoesNotExistException - if block cannot be found

IOException

requestSpace

void requestSpace(long sessionId,
                  long blockId,
                  long additionalBytes)
           throws BlockDoesNotExistException,
                  WorkerOutOfSpaceException,
                  IOException

Request an amount of space for a block in its storage directory. The block must be a temporary block.

Parameters:

sessionId - the id of the client

blockId - the id of the block to allocate space to

additionalBytes - the amount of bytes to allocate

Throws:

BlockDoesNotExistException - if blockId can not be found, or some block in eviction plan cannot be found

WorkerOutOfSpaceException - if requested space can not be satisfied

IOException

unlockBlock

void unlockBlock(long lockId)
          throws BlockDoesNotExistException

Releases the lock with the specified lock id.

Parameters:

lockId - the id of the lock to release

Throws:

BlockDoesNotExistException - if lock id cannot be found

asyncCache

@Deprecated
void asyncCache(AsyncCacheRequest request)

Deprecated. This method will be deprecated as of v3.0, use cache

Submits the async cache request to async cache manager to execute.

Parameters:

request - the async cache request

cache

void cache(CacheRequest request)
    throws AlluxioException,
           IOException

Submits the cache request to cache manager to execute.

Parameters:

request - the cache request

Throws:

AlluxioException

IOException

updatePinList

void updatePinList(Set<Long> pinnedInodes)

Sets the pinlist for the underlying block store.

Parameters:

pinnedInodes - a set of pinned inodes

getFileInfo

FileInfo getFileInfo(long fileId)
              throws IOException

Gets the file information.

Parameters:

fileId - the file id

Returns:

the file info

Throws:

IOException

clearMetrics

void clearMetrics()

Clears the worker metrics.

getConfiguration

Configuration getConfiguration(GetConfigurationPOptions options)

Parameters:

options - method options

Returns:

configuration information list

getWhiteList

List<String> getWhiteList()

Returns:

the white list