org.corfudb.runtime.view

Class AddressSpaceView

java.lang.Object

org.corfudb.runtime.view.AbstractView

org.corfudb.runtime.view.AddressSpaceView

public class AddressSpaceView
extends AbstractView

A view of the address space implemented by Corfu.

Created by mwei on 12/10/15.

Nested Class Summary

Nested classes/interfaces inherited from class org.corfudb.runtime.view.AbstractView

AbstractView.LayoutFunction<V,R,A extends Throwable,B extends Throwable,C extends Throwable,D extends Throwable>

Constructor Summary

Constructors

Constructor and Description
AddressSpaceView(CorfuRuntime runtime) Constructor for the Address Space View.

Method Summary

Modifier and Type	Method and Description
ILogData	fetch(long address) Explicitly fetch a given address, bypassing the cache.
Map<Long,ILogData>	fetchAll(Iterable<Long> addresses, boolean waitForWrite) Fetch a collection of addresses for insertion into the cache.
void	gc() Force compaction on an address space, which will force all log units to free space, and process any outstanding trim requests.
void	gc(long trimMark) Remove all log entries that are less than the trim mark
TailsResponse	getAllTails() Get all tails, includes: log tail and stream tails.
StreamsAddressResponse	getLogAddressSpace() Get log address space, which includes: 1.
Long	getLogTail() Get the log's tail, i.e., last address in the address space.
Token	getTrimMark() Get the first address in the address space.
void	invalidateClientCache() Force the client cache to be invalidated.
void	invalidateServerCaches() Force all server caches to be invalidated.
ILogData	peek(long address) Directly read from the log, returning any committed value, or NULL, if no value has been committed.
ILogData	predictiveReadRange(Long nextRead, List<Long> addresses) This method reads a batch of addresses if 'nextRead' is not found in the cache.
void	prefixTrim(Token address) Prefix trim the address space.
Map<Long,ILogData>	read(Iterable<Long> addresses) Read the given object from a range of addresses.
Map<Long,ILogData>	read(Iterable<Long> addresses, boolean waitForWrite) Read the given object from a range of addresses.
ILogData	read(long address) Read the given object from an address and streams.
void	resetCaches() Reset all in-memory caches.
void	write(IToken token, Object data) Write the given log data and then add it to the address space cache (i.e.
void	write(IToken token, Object data, CacheOption cacheOption) Write the given log data using a token, returning either when the write has been completed successfully, or throwing an OverwriteException if another value has been adopted, or a WrongEpochException if the token epoch is invalid.

Methods inherited from class org.corfudb.runtime.view.AbstractView

getCurrentLayout, layoutHelper, layoutHelper

Methods inherited from class java.lang.Object

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

Constructor Detail

AddressSpaceView

public AddressSpaceView(@Nonnull
                        CorfuRuntime runtime)

Constructor for the Address Space View.

Method Detail

gc

public void gc(long trimMark)

Remove all log entries that are less than the trim mark

resetCaches

public void resetCaches()

Reset all in-memory caches.

write

public void write(@Nonnull
                  IToken token,
                  @Nonnull
                  Object data,
                  @Nonnull
                  CacheOption cacheOption)

Write the given log data using a token, returning either when the write has been completed successfully, or throwing an OverwriteException if another value has been adopted, or a WrongEpochException if the token epoch is invalid.

Parameters:

token - The token to use for the write.

data - The data to write.

cacheOption - The caching behaviour for this write

Throws:

OverwriteException - If the globalAddress given by the token has adopted another value.

WrongEpochException - If the token epoch is invalid.

write

public void write(IToken token,
                  Object data)
           throws OverwriteException

Write the given log data and then add it to the address space cache (i.e. WRITE_THROUGH option)

Throws:

OverwriteException

See Also:

write(IToken, Object, CacheOption)

peek

@Nullable
public ILogData peek(long address)

Directly read from the log, returning any committed value, or NULL, if no value has been committed.

Parameters:

address - The address to read from.

Returns:

Committed data stored in the log, or NULL, if no value has been committed.

read

@Nonnull
public ILogData read(long address)

Read the given object from an address and streams.

Parameters:

address - An address to read from.

Returns:

A result, which be cached.

predictiveReadRange

@Nonnull
public ILogData predictiveReadRange(Long nextRead,
                                             List<Long> addresses)

This method reads a batch of addresses if 'nextRead' is not found in the cache. In the case of a cache miss, it piggybacks on the read for nextRead. If 'nextRead' is present in the cache, it directly returns this data.

Parameters:

nextRead - current address of interest

addresses - batch of addresses to read (bring into the cache) in case there is a cache miss (includes nextRead)

Returns:

data for current 'address' of interest.

read

public Map<Long,ILogData> read(Iterable<Long> addresses)

Read the given object from a range of addresses. - If the waitForWrite flag is set to true, when an empty address is encountered, it waits for one hole to be filled. All the rest empty addresses within the list are hole filled directly and the reader does not wait. - In case the flag is set to false, none of the reads wait for write completion and the empty addresses are hole filled right away.

Parameters:

addresses - An iterable with addresses to read from

Returns:

A result, which be cached.

read

public Map<Long,ILogData> read(Iterable<Long> addresses,
                               boolean waitForWrite)

Read the given object from a range of addresses.

Parameters:

addresses - An iterable with addresses to read from

waitForWrite - Flag whether wait for write is required or hole fill directly.

Returns:

A map of addresses read, which will be cached if caching is enabled

getTrimMark

public Token getTrimMark()

Get the first address in the address space.

getLogTail

public Long getLogTail()

Get the log's tail, i.e., last address in the address space.

getAllTails

public TailsResponse getAllTails()

Get all tails, includes: log tail and stream tails.

getLogAddressSpace

public StreamsAddressResponse getLogAddressSpace()

Get log address space, which includes: 1. Addresses belonging to each stream. 2. Log Tail.

Returns:

prefixTrim

public void prefixTrim(Token address)

Prefix trim the address space.

At the end of a prefix trim, all addresses equal to or less than the address given will be marked for trimming, which means that they may return either the original data, or a trimmed exception.

Parameters:

address - log address

gc

public void gc()

Force compaction on an address space, which will force all log units to free space, and process any outstanding trim requests.

invalidateServerCaches

public void invalidateServerCaches()

Force all server caches to be invalidated.

invalidateClientCache

public void invalidateClientCache()

Force the client cache to be invalidated.

fetchAll

@Nonnull
public Map<Long,ILogData> fetchAll(Iterable<Long> addresses,
                                            boolean waitForWrite)

Fetch a collection of addresses for insertion into the cache. The result map returned is ordered by address.

Parameters:

addresses - collection of addresses to read from.

waitForWrite - flag whether wait for write is required or hole fill directly.

Returns:

a ordered map of read addresses.

fetch

@Nonnull
public ILogData fetch(long address)

Explicitly fetch a given address, bypassing the cache.

Parameters:

address - an address to read from.

Returns:

the log data read at address