com.facebook.buck.support.state

Class BuckGlobalState

java.lang.Object

com.facebook.buck.support.state.BuckGlobalState

All Implemented Interfaces:

Closeable, AutoCloseable

public final class BuckGlobalState
extends Object
implements Closeable

BuckGlobalState contains all the global state of Buck which is kept between invocations of Buck commands, like caches, global per-process objects, etc. Individual caches here can be hooked to Watchman for proper invalidation.

This state is uniformly invalidated on major changes, like configuration changes, so it is essential all in-proc caches to contain in this class for proper invalidation. If caches need to be kept between configuration changes, a custom logic should reside in BuckGlobalStateLifecycleManager

All Graph Engine caches are required to be kept here.

Method Summary

Modifier and Type	Method and Description
void	close()
ActionGraphCache	getActionGraphCache()
com.google.common.cache.LoadingCache<Path,BuildFileManifestCache>	getBuildFileManifestCaches() Return a map of all build file manifest caches for each cell which is a key
DaemonicParserState	getDaemonicParserState()
RuleKeyCacheRecycler<RuleKey>	getDefaultRuleKeyFactoryCacheRecycler()
com.google.common.cache.LoadingCache<Path,DirectoryListCache>	getDirectoryListCaches() Return a map of all directory list caches for each cell which is a key.
com.google.common.eventbus.EventBus	getFileEventBus() Global event bus used to process file invalidation events.
com.google.common.collect.ImmutableList<ProjectFileHashCache>	getFileHashCaches()
com.google.common.cache.LoadingCache<Path,FileTreeCache>	getFileTreeCaches() Return a map of file tree caches for each cell which is a key.
KnownRuleTypesProvider	getKnownRuleTypesProvider()
ConcurrentMap<String,WorkerProcessPool>	getPersistentWorkerPools()
TypeCoercerFactory	getTypeCoercerFactory()
long	getUptime()
boolean	getUsesWatchman()
VersionedTargetGraphCache	getVersionedTargetGraphCache()
com.google.common.collect.ImmutableMap<AbsPath,WatchmanCursor>	getWatchmanCursor()
Optional<WebServer>	getWebServer()
void	interruptOnClientExit(Thread threadToInterrupt)
void	watchFileSystem(BuckEventBus eventBus, WatchmanWatcher watchmanWatcher, WatchmanWatcher.FreshInstanceAction watchmanFreshInstanceAction)

Methods inherited from class java.lang.Object

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

Method Detail

getWebServer

public Optional<WebServer> getWebServer()

getTypeCoercerFactory

public TypeCoercerFactory getTypeCoercerFactory()

getVersionedTargetGraphCache

public VersionedTargetGraphCache getVersionedTargetGraphCache()

getActionGraphCache

public ActionGraphCache getActionGraphCache()

getFileHashCaches

public com.google.common.collect.ImmutableList<ProjectFileHashCache> getFileHashCaches()

getDirectoryListCaches

public com.google.common.cache.LoadingCache<Path,DirectoryListCache> getDirectoryListCaches()

Return a map of all directory list caches for each cell which is a key. For every cell, we cache directory structure (i.e. list of files and folders) for all subfolders that exist under that cell root folder

getBuildFileManifestCaches

public com.google.common.cache.LoadingCache<Path,BuildFileManifestCache> getBuildFileManifestCaches()

Return a map of all build file manifest caches for each cell which is a key

getFileTreeCaches

public com.google.common.cache.LoadingCache<Path,FileTreeCache> getFileTreeCaches()

Return a map of file tree caches for each cell which is a key. For every cell and each subfolder under cell root path, we cache the whole subtree of folders and files recursively

getKnownRuleTypesProvider

public KnownRuleTypesProvider getKnownRuleTypesProvider()

getPersistentWorkerPools

public ConcurrentMap<String,WorkerProcessPool> getPersistentWorkerPools()

getDefaultRuleKeyFactoryCacheRecycler

public RuleKeyCacheRecycler<RuleKey> getDefaultRuleKeyFactoryCacheRecycler()

getDaemonicParserState

public DaemonicParserState getDaemonicParserState()

interruptOnClientExit

public void interruptOnClientExit(Thread threadToInterrupt)

watchFileSystem

public void watchFileSystem(BuckEventBus eventBus,
                            WatchmanWatcher watchmanWatcher,
                            WatchmanWatcher.FreshInstanceAction watchmanFreshInstanceAction)
                     throws IOException,
                            InterruptedException

Throws:

IOException

InterruptedException

getFileEventBus

public com.google.common.eventbus.EventBus getFileEventBus()

Global event bus used to process file invalidation events. This event bus is synchronous.

getWatchmanCursor

public com.google.common.collect.ImmutableMap<AbsPath,WatchmanCursor> getWatchmanCursor()

getUsesWatchman

public boolean getUsesWatchman()

Returns:

true if state was created with Watchman service initialized

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getUptime

public long getUptime()

Returns:

the length of time in millis since this daemon was started