JGit 7.2.0.202503040940-r · org.eclipse.jgit.internal.storage.dfs.DfsGarbageCollector

Modifier and Type	Field and Description
private Set<ObjectId>	allHeadsAndTags
private Set<ObjectId>	allTags
private long	coalesceGarbageLimit
private boolean	convertToReftable
private DfsReader	ctx
private List<DfsPackFile>	expiredGarbagePacks
private long	garbageTtlMillis
private boolean	includeDeletes
private final List<DfsPackDescription>	newPackDesc
private final List<ObjectIdSet>	newPackObj
private final List<PackStatistics>	newPackStats
private Set<ObjectId>	nonHeads
private final DfsObjDatabase	objdb
private PackConfig	packConfig
private List<DfsPackFile>	packsBefore
private final RefDatabase	refdb
private Instant	refLogExpire
private Collection<Ref>	refsBefore
private ReftableConfig	reftableConfig
private long	reftableInitialMaxUpdateIndex
private long	reftableInitialMinUpdateIndex
private List<DfsReftable>	reftablesBefore
private final DfsRepository	repo
private Instant	startTime
private Set<ObjectId>	tagTargets
private boolean	writeBloomFilter
private boolean	writeCommitGraph

Access	Constructor and Description
public	DfsGarbageCollector(DfsRepository repository objects to be packed will be read from. repository) Initialize a garbage collector.

Method Summary

Modifier and Type	Method and Description
private boolean	anyPackHas(AnyObjectId id)
private static long	dayStartInMillis(long timeInMillis)
private long	estimateGcPackSize(DfsObjDatabase.PackSource first, DfsObjDatabase.PackSource... rest)
private Collection<Ref>	getAllRefs()
public long	Returns: coalesce garbage limit, packs smaller than this size will be repacked. getCoalesceGarbageLimit() Get coalesce garbage limit
public long	Returns: garbage packs older than this limit (in milliseconds) will be pruned as part of the garbage collection process if the value is > 0, otherwise garbage packs are retained. getGarbageTtlMillis() Get time to live for garbage packs.
public List<DfsPackDescription>	Returns: new packs created by this compaction. getNewPacks() Get new packs created by this compaction.
public List<PackStatistics>	Returns: statistics corresponding to the `getNewPacks()`. getNewPackStatistics() Get statistics corresponding to the `getNewPacks()`.
public PackConfig	Returns: configuration used to generate the new pack file. getPackConfig() Get configuration used to generate the new pack file.
public Set<DfsPackDescription>	Returns: all of the source packs that fed into this compaction. getSourcePacks() Get all of the source packs that fed into this compaction.
private boolean	hasGcReftable()
private static boolean	isHead(Ref ref)
private static boolean	isTag(Ref ref)
private PackWriter	newPackWriter()
private int	objectsBefore()
public boolean	Returns: true if the repack was successful without race conditions. False if a race condition was detected and the repack should be run again later. pack(ProgressMonitor progress monitor to receive updates on as packing may take a while, depending on the size of the repository. pm) Create a single new pack file containing all of the live objects.
private void	packGarbage(ProgressMonitor pm)
private void	packHeads(ProgressMonitor pm)
private boolean	packIsCoalesceableGarbage(DfsPackDescription d, long now)
private boolean	packIsExpiredGarbage(DfsPackDescription d, long now)
private void	packRest(ProgressMonitor pm)
private void	readPacksBefore()
private void	readReftablesBefore()
public DfsGarbageCollector	Returns: `this` setCoalesceGarbageLimit(long size in bytes. limit) Set the byte size limit for garbage packs to be repacked.
public DfsGarbageCollector	Returns: `this` setConvertToReftable(boolean if `true`, `setReftableConfig(ReftableConfig)` has been set non-null, and a GC reftable doesn't yet exist, the garbage collector will make one by scanning the existing references, and writing a new reftable. Default is `true`. convert) Whether the garbage collector should convert references to reftable.
public DfsGarbageCollector	Returns: `this` setGarbageTtl(long Time to live whatever unit is specified. ttl, TimeUnit The specified time unit. unit) Set the time to live for garbage objects.
public DfsGarbageCollector	Returns: `this` setIncludeDeletes(boolean if `true`, the garbage collector will include tombstones for deleted references in the reftable. Default is `false`. include) Whether the garbage collector will include tombstones for deleted references in the reftable.
public DfsGarbageCollector	Returns: `this` setPackConfig(PackConfig the new configuration to use when creating the pack file. newConfig) Set the new configuration to use when creating the pack file.
public DfsGarbageCollector	Returns: `this` setRefLogExpire(Instant instant in time which defines refLog expiration refLogExpire) Set time limit to the reflog history.
public DfsGarbageCollector	Returns: `this` setReftableConfig(ReftableConfig configuration to write a reftable. Reftable writing is disabled (default) when `cfg` is `null`. cfg) Set configuration to write a reftable.
public DfsGarbageCollector	Returns: `this` setReftableInitialMaxUpdateIndex(long maxUpdateIndex for the initial reftable created by scanning `org.eclipse.jgit.internal.storage.dfs.DfsRefDatabase#getRefs(String)`. Ignored unless caller has also set `setReftableConfig(ReftableConfig)`. Defaults to `1`. Must be `u >= 0`. u) Set maxUpdateIndex for the initial reftable created during conversion.
public DfsGarbageCollector	Returns: `this` setReftableInitialMinUpdateIndex(long minUpdateIndex for the initial reftable created by scanning `org.eclipse.jgit.internal.storage.dfs.DfsRefDatabase#getRefs(String)`. Ignored unless caller has also set `setReftableConfig(ReftableConfig)`. Defaults to `1`. Must be `u >= 0`. u) Set minUpdateIndex for the initial reftable created during conversion.
public DfsGarbageCollector	Returns: `this` setWriteBloomFilter(boolean Whether bloom filter generation is enabled enable) Toggle bloom filter generation.
public DfsGarbageCollector	Returns: `this` setWriteCommitGraph(boolean Allow/Disallow commit graph generation. enable) Toggle commit graph generation.
private Set<DfsPackDescription>	toPrune()
private void	writeCommitGraph(DfsPackDescription pack, ProgressMonitor pm)
private DfsPackDescription	writePack(DfsObjDatabase.PackSource source, PackWriter pw, ProgressMonitor pm, long estimatedPackSize)
private void	writeReftable()
private void	writeReftable(DfsPackDescription pack)
private void	writeReftable(DfsPackDescription pack, Collection<Ref> refs)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

allHeadsAndTags	back to summary
private Set<ObjectId> allHeadsAndTags

allTags	back to summary
private Set<ObjectId> allTags

coalesceGarbageLimit	back to summary
private long coalesceGarbageLimit

convertToReftable	back to summary
private boolean convertToReftable

ctx	back to summary
private DfsReader ctx

expiredGarbagePacks	back to summary
private List<DfsPackFile> expiredGarbagePacks

garbageTtlMillis	back to summary
private long garbageTtlMillis

includeDeletes	back to summary
private boolean includeDeletes

newPackDesc	back to summary
private final List<DfsPackDescription> newPackDesc

newPackObj	back to summary
private final List<ObjectIdSet> newPackObj

newPackStats	back to summary
private final List<PackStatistics> newPackStats

nonHeads	back to summary
private Set<ObjectId> nonHeads

objdb	back to summary
private final DfsObjDatabase objdb

packConfig	back to summary
private PackConfig packConfig

packsBefore	back to summary
private List<DfsPackFile> packsBefore

refdb	back to summary
private final RefDatabase refdb

refLogExpire	back to summary
private Instant refLogExpire

refsBefore	back to summary
private Collection<Ref> refsBefore

reftableConfig	back to summary
private ReftableConfig reftableConfig

reftableInitialMaxUpdateIndex	back to summary
private long reftableInitialMaxUpdateIndex

reftableInitialMinUpdateIndex	back to summary
private long reftableInitialMinUpdateIndex

reftablesBefore	back to summary
private List<DfsReftable> reftablesBefore

repo	back to summary
private final DfsRepository repo

startTime	back to summary
private Instant startTime

tagTargets	back to summary
private Set<ObjectId> tagTargets

writeBloomFilter	back to summary
private boolean writeBloomFilter

writeCommitGraph	back to summary
private boolean writeCommitGraph

DfsGarbageCollector	back to summary
public DfsGarbageCollector(DfsRepository repository) Initialize a garbage collector. Parameters repository:DfsRepository repository objects to be packed will be read from.

Method Detail

anyPackHas	back to summary
private boolean anyPackHas(AnyObjectId id)

dayStartInMillis	back to summary
private static long dayStartInMillis(long timeInMillis)

estimateGcPackSize	back to summary
private long estimateGcPackSize(DfsObjDatabase.PackSource first, DfsObjDatabase.PackSource... rest)

getAllRefs	back to summary
private Collection<Ref> getAllRefs() throws IOException

getCoalesceGarbageLimit	back to summary
public long getCoalesceGarbageLimit() Get coalesce garbage limit Returns:long coalesce garbage limit, packs smaller than this size will be repacked.

getCoalesceGarbageLimit

back to summary

public long getCoalesceGarbageLimit()

Get coalesce garbage limit

Returns:long: coalesce garbage limit, packs smaller than this size will be repacked.

getGarbageTtlMillis	back to summary
public long getGarbageTtlMillis() Get time to live for garbage packs. Returns:long garbage packs older than this limit (in milliseconds) will be pruned as part of the garbage collection process if the value is > 0, otherwise garbage packs are retained.

getGarbageTtlMillis

back to summary

public long getGarbageTtlMillis()

Get time to live for garbage packs.

Returns:long: garbage packs older than this limit (in milliseconds) will be pruned as part of the garbage collection process if the value is > 0, otherwise garbage packs are retained.

getNewPacks	back to summary
public List<DfsPackDescription> getNewPacks() Get new packs created by this compaction. Returns:List<DfsPackDescription> new packs created by this compaction.

getNewPacks

back to summary

public List<DfsPackDescription> getNewPacks()

Get new packs created by this compaction.

Returns:List<DfsPackDescription>: new packs created by this compaction.

getNewPackStatistics back to summary

getNewPackStatistics	back to summary
public List<PackStatistics> getNewPackStatistics() Get statistics corresponding to the `getNewPacks()`. The elements can be null if the stat is not available for the pack file. Returns:List<PackStatistics> statistics corresponding to the `getNewPacks()`.

public List<PackStatistics> getNewPackStatistics()

Get statistics corresponding to the getNewPacks().

The elements can be null if the stat is not available for the pack file.

Returns:List<PackStatistics>: statistics corresponding to the getNewPacks().

getPackConfig	back to summary
public PackConfig getPackConfig() Get configuration used to generate the new pack file. Returns:PackConfig configuration used to generate the new pack file.

getPackConfig

back to summary

public PackConfig getPackConfig()

Get configuration used to generate the new pack file.

Returns:PackConfig: configuration used to generate the new pack file.

getSourcePacks	back to summary
public Set<DfsPackDescription> getSourcePacks() Get all of the source packs that fed into this compaction. Returns:Set<DfsPackDescription> all of the source packs that fed into this compaction.

getSourcePacks

back to summary

public Set<DfsPackDescription> getSourcePacks()

Get all of the source packs that fed into this compaction.

Returns:Set<DfsPackDescription>: all of the source packs that fed into this compaction.

hasGcReftable	back to summary
private boolean hasGcReftable()

isHead	back to summary
private static boolean isHead(Ref ref)

isTag	back to summary
private static boolean isTag(Ref ref)

newPackWriter	back to summary
private PackWriter newPackWriter()

objectsBefore	back to summary
private int objectsBefore()

pack	back to summary
public boolean pack(ProgressMonitor pm) throws IOException Create a single new pack file containing all of the live objects. This method safely decides which packs can be expired after the new pack is created by validating the references have not been modified in an incompatible way. Parameters pm:ProgressMonitor progress monitor to receive updates on as packing may take a while, depending on the size of the repository. Returns:boolean true if the repack was successful without race conditions. False if a race condition was detected and the repack should be run again later. Exceptions IOException: a new pack cannot be created.

pack

back to summary

public boolean pack(ProgressMonitor pm) throws IOException

Create a single new pack file containing all of the live objects.

This method safely decides which packs can be expired after the new pack is created by validating the references have not been modified in an incompatible way.

Parameters

pm:ProgressMonitor: progress monitor to receive updates on as packing may take a while, depending on the size of the repository.

Returns:boolean

true if the repack was successful without race conditions. False if a race condition was detected and the repack should be run again later.

Exceptions

IOException:: a new pack cannot be created.

packGarbage	back to summary
private void packGarbage(ProgressMonitor pm) throws IOException

packHeads	back to summary
private void packHeads(ProgressMonitor pm) throws IOException

packIsCoalesceableGarbage	back to summary
private boolean packIsCoalesceableGarbage(DfsPackDescription d, long now)

packIsExpiredGarbage	back to summary
private boolean packIsExpiredGarbage(DfsPackDescription d, long now)

packRest	back to summary
private void packRest(ProgressMonitor pm) throws IOException

readPacksBefore	back to summary
private void readPacksBefore() throws IOException

readReftablesBefore	back to summary
private void readReftablesBefore() throws IOException

setCoalesceGarbageLimit back to summary

public DfsGarbageCollector setCoalesceGarbageLimit(long limit)

Set the byte size limit for garbage packs to be repacked.

Any UNREACHABLE_GARBAGE pack smaller than this limit will be repacked at the end of the run. This allows the garbage collector to coalesce unreachable objects into a single file.

If an UNREACHABLE_GARBAGE pack is already larger than this limit it will be left alone by the garbage collector. This avoids unnecessary disk IO reading and copying the objects.

If limit is set to 0 the UNREACHABLE_GARBAGE coalesce is disabled.
If limit is set to java.lang.Long#MAX_VALUE, everything is coalesced.

Keeping unreachable garbage prevents race conditions with repository changes that may suddenly need an object whose only copy was stored in the UNREACHABLE_GARBAGE pack.

Parameters

limit:long: size in bytes.

Returns:DfsGarbageCollector

this

setConvertToReftable back to summary

public DfsGarbageCollector setConvertToReftable(boolean convert)

Whether the garbage collector should convert references to reftable.

Parameters

convert:boolean: if true, setReftableConfig(ReftableConfig) has been set non-null, and a GC reftable doesn't yet exist, the garbage collector will make one by scanning the existing references, and writing a new reftable. Default is true.

Returns:DfsGarbageCollector

this

setGarbageTtl back to summary

public DfsGarbageCollector setGarbageTtl(long ttl, TimeUnit unit)

Set the time to live for garbage objects.

Any UNREACHABLE_GARBAGE older than this limit will be pruned at the end of the run.

If timeToLiveMillis is set to 0, UNREACHABLE_GARBAGE purging is disabled.

Parameters

ttl:long: Time to live whatever unit is specified.
unit:TimeUnit: The specified time unit.

Returns:DfsGarbageCollector

this

setIncludeDeletes back to summary

public DfsGarbageCollector setIncludeDeletes(boolean include)

Whether the garbage collector will include tombstones for deleted references in the reftable.

Parameters

include:boolean: if true, the garbage collector will include tombstones for deleted references in the reftable. Default is false.

Returns:DfsGarbageCollector

this

setPackConfig back to summary

public DfsGarbageCollector setPackConfig(PackConfig newConfig)

Set the new configuration to use when creating the pack file.

Parameters

newConfig:PackConfig: the new configuration to use when creating the pack file.

Returns:DfsGarbageCollector

this

setRefLogExpire back to summary

public DfsGarbageCollector setRefLogExpire(Instant refLogExpire)

Set time limit to the reflog history.

Garbage Collector prunes entries from reflog history older than refLogExpire

Parameters

refLogExpire:Instant: instant in time which defines refLog expiration

Returns:DfsGarbageCollector

this

setReftableConfig back to summary

public DfsGarbageCollector setReftableConfig(ReftableConfig cfg)

Set configuration to write a reftable.

Parameters

cfg:ReftableConfig: configuration to write a reftable. Reftable writing is disabled (default) when cfg is null.

Returns:DfsGarbageCollector

this

setReftableInitialMaxUpdateIndex back to summary

public DfsGarbageCollector setReftableInitialMaxUpdateIndex(long u)

Set maxUpdateIndex for the initial reftable created during conversion.

Parameters

u:long: maxUpdateIndex for the initial reftable created by scanning org.eclipse.jgit.internal.storage.dfs.DfsRefDatabase#getRefs(String). Ignored unless caller has also set setReftableConfig(ReftableConfig). Defaults to 1. Must be u >= 0.

Returns:DfsGarbageCollector

this

setReftableInitialMinUpdateIndex back to summary

public DfsGarbageCollector setReftableInitialMinUpdateIndex(long u)

Set minUpdateIndex for the initial reftable created during conversion.

Parameters

u:long: minUpdateIndex for the initial reftable created by scanning org.eclipse.jgit.internal.storage.dfs.DfsRefDatabase#getRefs(String). Ignored unless caller has also set setReftableConfig(ReftableConfig). Defaults to 1. Must be u >= 0.

Returns:DfsGarbageCollector

this

setWriteBloomFilter back to summary

public DfsGarbageCollector setWriteBloomFilter(boolean enable)

Toggle bloom filter generation.

False by default.

Parameters

enable:boolean: Whether bloom filter generation is enabled

Returns:DfsGarbageCollector

this

setWriteCommitGraph back to summary

public DfsGarbageCollector setWriteCommitGraph(boolean enable)

Toggle commit graph generation.

False by default.

Parameters

enable:boolean: Allow/Disallow commit graph generation.

Returns:DfsGarbageCollector

this

toPrune	back to summary
private Set<DfsPackDescription> toPrune()

writeCommitGraph	back to summary
private void writeCommitGraph(DfsPackDescription pack, ProgressMonitor pm) throws IOException

writePack	back to summary
private DfsPackDescription writePack(DfsObjDatabase.PackSource source, PackWriter pw, ProgressMonitor pm, long estimatedPackSize) throws IOException

writeReftable	back to summary
private void writeReftable() throws IOException

writeReftable	back to summary
private void writeReftable(DfsPackDescription pack) throws IOException

writeReftable	back to summary
private void writeReftable(DfsPackDescription pack, Collection<Ref> refs) throws IOException

public Class DfsGarbageCollector

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail