com.facebook.buck.artifact_cache

Class AbstractAsynchronousCache

java.lang.Object

com.facebook.buck.artifact_cache.AbstractAsynchronousCache

All Implemented Interfaces:

ArtifactCache, AutoCloseable

Direct Known Subclasses:

AbstractNetworkCache

public abstract class AbstractAsynchronousCache
extends Object
implements ArtifactCache

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractAsynchronousCache.CacheEventListener
protected static class	AbstractAsynchronousCache.FetchRequest
static interface	AbstractAsynchronousCache.StoreEvents

Constructor Summary

Constructors

Constructor and Description
AbstractAsynchronousCache(String name, ArtifactCacheMode mode, CacheReadMode cacheReadMode, com.google.common.util.concurrent.ListeningExecutorService storeExecutorService, com.google.common.util.concurrent.ListeningExecutorService fetchExecutorService, AbstractAsynchronousCache.CacheEventListener eventListener, Optional<Long> maxStoreSize, ProjectFilesystem projectFilesystem)

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<CacheDeleteResult>	deleteAsync(List<RuleKey> ruleKeys)
protected abstract CacheDeleteResult	deleteImpl(List<RuleKey> ruleKeys)
com.google.common.util.concurrent.ListenableFuture<CacheResult>	fetchAsync(BuildTarget target, RuleKey ruleKey, LazyPath output) Fetch a cached artifact, keyed by ruleKey, save the artifact to path specified by output, and return true on success.
protected abstract com.facebook.buck.artifact_cache.AbstractAsynchronousCache.FetchResult	fetchImpl(BuildTarget target, RuleKey ruleKey, LazyPath output)
CacheReadMode	getCacheReadMode() This method must return the same value over the lifetime of this object.
protected ArtifactCacheMode	getMode()
protected int	getMultiFetchBatchSize(int pendingRequestsSize) Used to compute the number of keys to include in every multiFetchRequest.
protected String	getName()
protected ProjectFilesystem	getProjectFilesystem()
protected boolean	isMultiCheckEnabled()
com.google.common.util.concurrent.ListenableFuture<com.google.common.collect.ImmutableMap<RuleKey,CacheResult>>	multiContainsAsync(com.google.common.collect.ImmutableSet<RuleKey> ruleKeys) Check if the cache contains the given artifacts, keyed by ruleKeys, without fetching them, and return a map of results wrapped in a ListenableFuture.
protected abstract com.facebook.buck.artifact_cache.AbstractAsynchronousCache.MultiContainsResult	multiContainsImpl(com.google.common.collect.ImmutableSet<RuleKey> ruleKeys)
protected abstract com.facebook.buck.artifact_cache.AbstractAsynchronousCache.MultiFetchResult	multiFetchImpl(Iterable<AbstractAsynchronousCache.FetchRequest> requests) The MultiFetchResult should contain results in the same order as the requests.
void	skipPendingAndFutureAsyncFetches() All pending (and future) async fetches will be immediately marked as skipped.
com.google.common.util.concurrent.ListenableFuture<Unit>	store(ArtifactInfo info, BorrowablePath output) Store the artifact at path specified by output to cache, such that it can later be fetched using ruleKey as the lookup key.
com.google.common.util.concurrent.ListenableFuture<Unit>	store(com.google.common.collect.ImmutableList<Pair<ArtifactInfo,BorrowablePath>> artifacts) Store the list of artifacts at path specified by output to cache in passed order, such that it can later be fetched using ruleKey as the lookup key.
protected abstract com.facebook.buck.artifact_cache.AbstractAsynchronousCache.StoreResult	storeImpl(ArtifactInfo info, Path file)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.artifact_cache.ArtifactCache

close

Constructor Detail

AbstractAsynchronousCache

public AbstractAsynchronousCache(String name,
                                 ArtifactCacheMode mode,
                                 CacheReadMode cacheReadMode,
                                 com.google.common.util.concurrent.ListeningExecutorService storeExecutorService,
                                 com.google.common.util.concurrent.ListeningExecutorService fetchExecutorService,
                                 AbstractAsynchronousCache.CacheEventListener eventListener,
                                 Optional<Long> maxStoreSize,
                                 ProjectFilesystem projectFilesystem)

Method Detail

getName

protected final String getName()

getMode

protected final ArtifactCacheMode getMode()

getProjectFilesystem

protected final ProjectFilesystem getProjectFilesystem()

fetchImpl

protected abstract com.facebook.buck.artifact_cache.AbstractAsynchronousCache.FetchResult fetchImpl(@Nullable
                                                                                                    BuildTarget target,
                                                                                                    RuleKey ruleKey,
                                                                                                    LazyPath output)
                                                                                             throws IOException

Throws:

IOException

multiContainsImpl

protected abstract com.facebook.buck.artifact_cache.AbstractAsynchronousCache.MultiContainsResult multiContainsImpl(com.google.common.collect.ImmutableSet<RuleKey> ruleKeys)
                                                                                                             throws IOException

Throws:

IOException

storeImpl

protected abstract com.facebook.buck.artifact_cache.AbstractAsynchronousCache.StoreResult storeImpl(ArtifactInfo info,
                                                                                                    Path file)
                                                                                             throws IOException

Throws:

IOException

deleteImpl

protected abstract CacheDeleteResult deleteImpl(List<RuleKey> ruleKeys)
                                         throws IOException

Throws:

IOException

multiFetchImpl

protected abstract com.facebook.buck.artifact_cache.AbstractAsynchronousCache.MultiFetchResult multiFetchImpl(Iterable<AbstractAsynchronousCache.FetchRequest> requests)
                                                                                                       throws IOException

The MultiFetchResult should contain results in the same order as the requests.

Throws:

IOException

getMultiFetchBatchSize

protected int getMultiFetchBatchSize(int pendingRequestsSize)

Used to compute the number of keys to include in every multiFetchRequest. If < 1, fetch will be used instead of multifetch.

isMultiCheckEnabled

protected boolean isMultiCheckEnabled()

skipPendingAndFutureAsyncFetches

public void skipPendingAndFutureAsyncFetches()

Description copied from interface: ArtifactCache

All pending (and future) async fetches will be immediately marked as skipped.

Specified by:

skipPendingAndFutureAsyncFetches in interface ArtifactCache

fetchAsync

public final com.google.common.util.concurrent.ListenableFuture<CacheResult> fetchAsync(@Nullable
                                                                                        BuildTarget target,
                                                                                        RuleKey ruleKey,
                                                                                        LazyPath output)

Description copied from interface: ArtifactCache

Fetch a cached artifact, keyed by ruleKey, save the artifact to path specified by output, and return true on success.

Specified by:

fetchAsync in interface ArtifactCache

Parameters:

target - rule for which this is an artifact

ruleKey - cache fetch key

output - Path to store artifact to. Path should not be accessed unless store operation is guaranteed by the cache, to avoid potential extra disk I/O.

Returns:

whether it was a CacheResultType.MISS (indicating a failure) or some type of hit.

multiContainsAsync

public final com.google.common.util.concurrent.ListenableFuture<com.google.common.collect.ImmutableMap<RuleKey,CacheResult>> multiContainsAsync(com.google.common.collect.ImmutableSet<RuleKey> ruleKeys)

Description copied from interface: ArtifactCache

Check if the cache contains the given artifacts, keyed by ruleKeys, without fetching them, and return a map of results wrapped in a ListenableFuture. This is supposed to be fast, but best-effort, meaning that there will be false-positives.

Specified by:

multiContainsAsync in interface ArtifactCache

Parameters:

ruleKeys - Set of cache fetch keys.

Returns:

map of keys to CacheResult which can be a CacheResultType.MISS / CacheResultType.ERROR (indicating a failure) or CacheResultType.CONTAINS.

store

public final com.google.common.util.concurrent.ListenableFuture<Unit> store(ArtifactInfo info,
                                                                            BorrowablePath output)

Description copied from interface: ArtifactCache

Store the artifact at path specified by output to cache, such that it can later be fetched using ruleKey as the lookup key. If any internal errors occur, fail silently and continue execution. Store may be performed synchronously or asynchronously.

This is a noop if ArtifactCache.getCacheReadMode()} returns READONLY.

Specified by:

store in interface ArtifactCache

Parameters:

info - information to store with the artifact

output - path to read artifact from. If its borrowable, you may freely move the file into cache without obtaining a copy of the file.

Returns:

ListenableFuture that completes once the store has finished.

store

public final com.google.common.util.concurrent.ListenableFuture<Unit> store(com.google.common.collect.ImmutableList<Pair<ArtifactInfo,BorrowablePath>> artifacts)

Description copied from interface: ArtifactCache

Store the list of artifacts at path specified by output to cache in passed order, such that it can later be fetched using ruleKey as the lookup key. If any internal errors occur, fail silently and continue execution. Store may be performed synchronously or asynchronously.

This is a noop if ArtifactCache.getCacheReadMode()} returns READONLY.

Specified by:

store in interface ArtifactCache

Parameters:

artifacts - list of artifact info and path to be uploaded to the cache in given order.

Returns:

ListenableFuture that completes once the store has finished.

deleteAsync

public final com.google.common.util.concurrent.ListenableFuture<CacheDeleteResult> deleteAsync(List<RuleKey> ruleKeys)

Specified by:

deleteAsync in interface ArtifactCache

getCacheReadMode

public final CacheReadMode getCacheReadMode()

Description copied from interface: ArtifactCache

This method must return the same value over the lifetime of this object.

Specified by:

getCacheReadMode in interface ArtifactCache

Returns:

whether thisArtifactCache supports storing artifacts.