alluxio.worker.block

Interface BlockWorker

All Superinterfaces:

Server<WorkerNetAddress>, SessionCleanable, Worker

All Known Implementing Classes:

AllMasterRegistrationBlockWorker, DefaultBlockWorker

public interface BlockWorker
extends Worker, SessionCleanable

A block worker in the Alluxio system.

Method Summary

Modifier and Type	Method and Description
void	abortBlock(long sessionId, long blockId) Aborts the temporary block created by the session.
void	asyncCache(AsyncCacheRequest request) Deprecated. This method will be deprecated as of v3.0, use cache(alluxio.grpc.CacheRequest)
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, CreateBlockOptions createBlockOptions) Creates a block in Alluxio managed space.
BlockReader	createBlockReader(long sessionId, long blockId, long offset, boolean positionShort, Protocol.OpenUfsBlockOptions options) 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, alluxio.worker.block.CreateBlockOptions).
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.
void	freeWorker() Frees all blocks in the current worker by deleting all block store directories.
BlockStore	getBlockStore()
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.
List<String>	getWhiteList()
WorkerNetAddress	getWorkerAddress()
AtomicReference<Long>	getWorkerId()
CompletableFuture<List<BlockStatus>>	load(List<Block> fileBlocks, UfsReadOptions options) Load blocks into alluxio.
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	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

Method Detail

getWorkerId

AtomicReference<Long> getWorkerId()

Returns:

the worker id

abortBlock

void abortBlock(long sessionId,
                long blockId)
         throws 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:

IOException

commitBlock

void commitBlock(long sessionId,
                 long blockId,
                 boolean pinOnCreate)

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

commitBlockInUfs

void commitBlockInUfs(long blockId,
                      long length)

Commits a block in UFS.

Parameters:

blockId - the id of the block to commit

length - length of the block to commit

createBlock

String createBlock(long sessionId,
                   long blockId,
                   int tier,
                   CreateBlockOptions createBlockOptions)

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

createBlockOptions - the createBlockOptions

Returns:

a string representing the path to the local file

createBlockWriter

BlockWriter createBlockWriter(long sessionId,
                              long blockId)
                       throws IOException

Creates a BlockWriter for an existing temporary block which is already created by createBlock(long, long, int, alluxio.worker.block.CreateBlockOptions).

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:

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

createBlockReader

BlockReader createBlockReader(long sessionId,
                              long blockId,
                              long offset,
                              boolean positionShort,
                              Protocol.OpenUfsBlockOptions options)
                       throws 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:

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:

a block reader to read data from

Throws:

IOException - if it fails to get block reader

createUfsBlockReader

BlockReader createUfsBlockReader(long sessionId,
                                 long blockId,
                                 long offset,
                                 boolean positionShort,
                                 Protocol.OpenUfsBlockOptions options)
                          throws 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:

IOException - if it fails to get block reader

removeBlock

void removeBlock(long sessionId,
                 long blockId)
          throws 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:

IOException

freeWorker

void freeWorker()
         throws IOException

Frees all blocks in the current worker by deleting all block store directories. Whether this method returns successfully or exceptionally, the worker should not be used in any way.

Throws:

IOException - if free fails

requestSpace

void requestSpace(long sessionId,
                  long blockId,
                  long additionalBytes)

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

asyncCache

@Deprecated
void asyncCache(AsyncCacheRequest request)

Deprecated. This method will be deprecated as of v3.0, use cache(alluxio.grpc.CacheRequest)

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

load

CompletableFuture<List<BlockStatus>> load(List<Block> fileBlocks,
                                          UfsReadOptions options)

Load blocks into alluxio.

Parameters:

fileBlocks - list of fileBlocks, one file blocks contains blocks belong to one file

options - read ufs options

Returns:

future of load status for failed blocks

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

getBlockStore

BlockStore getBlockStore()

Returns:

the block store

getWorkerAddress

WorkerNetAddress getWorkerAddress()

Returns:

the worker address