Class MarkSweepGarbageCollector
- java.lang.Object
-
- org.apache.jackrabbit.oak.plugins.blob.MarkSweepGarbageCollector
-
- All Implemented Interfaces:
BlobGarbageCollector
public class MarkSweepGarbageCollector extends Object implements BlobGarbageCollector
Mark and sweep garbage collector. Uses the file system to store internal state while in process to account for huge data. This class is not thread safe.
-
-
Constructor Summary
Constructors Constructor Description MarkSweepGarbageCollector(BlobReferenceRetriever marker, GarbageCollectableBlobStore blobStore, Executor executor, long maxLastModifiedInterval, @Nullable String repositoryId, @Nullable Whiteboard whiteboard, @Nullable StatisticsProvider statisticsProvider)
Instantiates a new blob garbage collector.MarkSweepGarbageCollector(BlobReferenceRetriever marker, GarbageCollectableBlobStore blobStore, Executor executor, String root, int batchCount, long maxLastModifiedInterval, boolean checkConsistencyAfterGc, boolean sweepIfRefsPastRetention, @Nullable String repositoryId, @Nullable Whiteboard whiteboard, @Nullable StatisticsProvider statisticsProvider)
Creates an instance of MarkSweepGarbageCollectorMarkSweepGarbageCollector(BlobReferenceRetriever marker, GarbageCollectableBlobStore blobStore, Executor executor, String root, int batchCount, long maxLastModifiedInterval, @Nullable String repositoryId)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description long
checkConsistency()
Checks for the DataStore consistency and reports the number of missing blobs still referenced.void
collectGarbage(boolean markOnly)
Marks garbage blobs from the passed node store instance.void
collectGarbage(boolean markOnly, boolean forceBlobRetrieve)
Marks garbage blobs from the passed node store instance.OperationsStatsMBean
getConsistencyOperationStats()
Returns consistency operation statisticsOperationsStatsMBean
getOperationStats()
Returns operation statisticsList<GarbageCollectionRepoStats>
getStats()
Returns the stats related to GC for all reposvoid
setClock(Clock clock)
void
setTraceOutput(boolean trace)
-
-
-
Field Detail
-
LOG
public static final Logger LOG
-
TEMP_DIR
public static final String TEMP_DIR
-
DEFAULT_BATCH_COUNT
public static final int DEFAULT_BATCH_COUNT
- See Also:
- Constant Field Values
-
DELIM
public static final String DELIM
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MarkSweepGarbageCollector
public MarkSweepGarbageCollector(BlobReferenceRetriever marker, GarbageCollectableBlobStore blobStore, Executor executor, String root, int batchCount, long maxLastModifiedInterval, boolean checkConsistencyAfterGc, boolean sweepIfRefsPastRetention, @Nullable @Nullable String repositoryId, @Nullable @Nullable Whiteboard whiteboard, @Nullable @Nullable StatisticsProvider statisticsProvider) throws IOException
Creates an instance of MarkSweepGarbageCollector- Parameters:
marker
- BlobReferenceRetriever instanced used to fetch refereed blob entriesblobStore
- the blob store instanceexecutor
- executorroot
- the root absolute path of directory under which temporary files would be createdbatchCount
- batch sized used for saving intermediate statemaxLastModifiedInterval
- lastModifiedTime in millis. Only files with time less than this time would be considered for GCrepositoryId
- unique repository id for this nodewhiteboard
- whiteboard instancestatisticsProvider
- statistics provider instance- Throws:
IOException
-
MarkSweepGarbageCollector
public MarkSweepGarbageCollector(BlobReferenceRetriever marker, GarbageCollectableBlobStore blobStore, Executor executor, String root, int batchCount, long maxLastModifiedInterval, @Nullable @Nullable String repositoryId) throws IOException
- Throws:
IOException
-
MarkSweepGarbageCollector
public MarkSweepGarbageCollector(BlobReferenceRetriever marker, GarbageCollectableBlobStore blobStore, Executor executor, long maxLastModifiedInterval, @Nullable @Nullable String repositoryId, @Nullable @Nullable Whiteboard whiteboard, @Nullable @Nullable StatisticsProvider statisticsProvider) throws IOException
Instantiates a new blob garbage collector.- Throws:
IOException
-
-
Method Detail
-
collectGarbage
public void collectGarbage(boolean markOnly) throws Exception
Description copied from interface:BlobGarbageCollector
Marks garbage blobs from the passed node store instance. Collects them only if markOnly is false.- Specified by:
collectGarbage
in interfaceBlobGarbageCollector
- Parameters:
markOnly
- whether to only mark references and not sweep in the mark and sweep operation.- Throws:
Exception
- the exception
-
collectGarbage
public void collectGarbage(boolean markOnly, boolean forceBlobRetrieve) throws Exception
Description copied from interface:BlobGarbageCollector
Marks garbage blobs from the passed node store instance. Collects them only if markOnly is false. Also forces retrieval of blob ids from the blob store rather than using any local tracking.- Specified by:
collectGarbage
in interfaceBlobGarbageCollector
- Parameters:
markOnly
- whether to only mark references and not sweep in the mark and sweep operation.forceBlobRetrieve
- whether to force retrieve of blob ids from datastore- Throws:
Exception
-
getStats
public List<GarbageCollectionRepoStats> getStats() throws Exception
Returns the stats related to GC for all repos- Specified by:
getStats
in interfaceBlobGarbageCollector
- Returns:
- a list of GarbageCollectionRepoStats objects
- Throws:
Exception
-
getOperationStats
public OperationsStatsMBean getOperationStats()
Description copied from interface:BlobGarbageCollector
Returns operation statistics- Specified by:
getOperationStats
in interfaceBlobGarbageCollector
- Returns:
- stats object
-
getConsistencyOperationStats
public OperationsStatsMBean getConsistencyOperationStats()
Description copied from interface:BlobGarbageCollector
Returns consistency operation statistics- Specified by:
getConsistencyOperationStats
in interfaceBlobGarbageCollector
- Returns:
- stats object
-
checkConsistency
public long checkConsistency() throws Exception
Checks for the DataStore consistency and reports the number of missing blobs still referenced.- Specified by:
checkConsistency
in interfaceBlobGarbageCollector
- Returns:
- the missing blobs
- Throws:
Exception
-
setTraceOutput
public void setTraceOutput(boolean trace)
-
setClock
public void setClock(Clock clock)
-
-