JGit 7.2.0.202503040940-r · org.eclipse.jgit.internal.storage.file.Pack

Modifier and Type	Class and Description
private static class	Pack.Delta

Field Summary

Modifier and Type	Field and Description
private int	activeCopyRawData
private final Object	activeLock For managing open/close accounting of `fd`.
private int	activeWindows
private Optionally<PackBitmapIndex>	bitmapIdx
private volatile PackFile	bitmapIdxFile
private volatile LongList	corruptObjects Objects we have tried to read, and discovered to be corrupt.
private RandomAccessFile	fd
private PackFileSnapshot	fileSnapshot
pack-priv final int	hash
private volatile boolean	invalid
private volatile Exception	invalidatingCause
private PackFile	keepFile
pack-priv long	length
private Optionally<PackIndex>	loadedIdx
private static final Logger	LOG
private byte[]	packChecksum
private final PackFile	packFile
pack-priv Instant	packLastModified
private final Object	readLock Serializes reads performed against `fd`.
private Optionally<PackReverseIndex>	reverseIdx
public static final Comparator<Pack>	SORT Sorts PackFiles to be most recently created to least recently created.
private AtomicInteger	transientErrorCount
private boolean	useStrongRefs

Constructor Summary

Access	Constructor and Description
public	Pack(Config configuration this directory consults for write settings. cfg, File path of the `.pack` file holding the data. packFile, PackFile existing bitmap index file with the same base as the pack bitmapIdxFile) Construct a reader for an existing, pre-indexed packfile.

Method Summary

Modifier and Type	Method and Description
private void	beginCopyAsIs()
pack-priv boolean	beginWindowCache()
public static void	close(Set<Pack> packs to close packs) Close the resources utilized by these pack files
public void	close() Close the resources utilized by this pack file
private synchronized void	closeIndices()
pack-priv final void	copyAsIs(PackOutputStream out, LocalObjectToPack src, boolean validate, WindowCursor curs)
private void	copyAsIs2(PackOutputStream out, LocalObjectToPack src, boolean validate, WindowCursor curs)
pack-priv void	copyPackAsIs(PackOutputStream out, WindowCursor curs)
private final byte[]	decompress(final long position, final int sz, final WindowCursor curs)
private void	doClose()
private void	doOpen()
private void	endCopyAsIs()
pack-priv boolean	endWindowCache()
private long	findDeltaBase(ObjectId baseId)
private long	findEndOffset(long startOffset)
pack-priv ObjectId	Returns: object id for this offset, or null if no object was found findObjectForOffset(long start offset of object to find offset) Search for object id with the specified start offset in associated pack (reverse) index.
pack-priv ObjectLoader	Returns: the object loader for the requested object if it is contained in this pack; null if the object was not found. get(WindowCursor temporary working space associated with the calling thread. curs, AnyObjectId the object to obtain from the pack. Must not be null. id) Get an object from this pack.
pack-priv synchronized PackBitmapIndex	getBitmapIndex()
pack-priv byte[]	getDeltaHeader(WindowCursor wc, long pos)
pack-priv PackFileSnapshot	Returns: the packfile @`FileSnapshot` that the object is loaded from. getFileSnapshot() Return the @`FileSnapshot` associated to the underlying packfile that has been used when the object was created.
public PackIndex	Returns: the index for this pack file. getIndex() Get the index for this pack file.
pack-priv long	Returns: number of objects in index of this pack, likewise in this pack getObjectCount() Obtain the total number of objects available in this pack.
pack-priv long	getObjectSize(WindowCursor curs, AnyObjectId id)
pack-priv long	getObjectSize(WindowCursor curs, long pos)
pack-priv int	getObjectType(WindowCursor curs, long pos)
pack-priv AnyObjectId	getPackChecksum()
public PackFile	Returns: the File object which locates this pack on disk. getPackFile() Get the File object which locates this pack on disk.
public String	Returns: name extracted from `pack-.pack` pattern. getPackName() Get name extracted from `pack-.pack` pattern.
private synchronized PackReverseIndex	getReverseIdx()
public boolean	Returns: true if the object is in this pack; false otherwise. hasObject(AnyObjectId the object to look for. Must not be null. id) Determine if an object is contained within the pack file.
private synchronized PackIndex	idx()
pack-priv int	incrementTransientErrorCount()
pack-priv boolean	invalid()
private boolean	isCorrupt(long offset)
public Iterator<PackIndex.MutableEntry>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
pack-priv ObjectLoader	load(WindowCursor curs, long pos)
pack-priv ByteWindow	mmap(long pos, int size)
private void	onOpenPack()
private void	openFail(Exception cause)
private <T> Optionally<T>	optionally(T element)
pack-priv ByteArrayWindow	read(long pos, int size)
private void	readFully(final long position, final byte[] dstbuf, int dstoff, final int cnt, final WindowCursor curs)
pack-priv LocalObjectRepresentation	representation(final WindowCursor curs, final AnyObjectId objectId)
pack-priv void	resetTransientErrorCount()
pack-priv void	resolve(Set<ObjectId> matches, AbbreviatedObjectId id, int matchLimit)
pack-priv void	setBitmapIndexFile(PackFile bitmapIndexFile)
private void	setCorrupt(long offset)
pack-priv void	setInvalid()
public boolean	Returns: true if a .keep file exist. shouldBeKept() Determines whether a .keep file exists for this pack file.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

activeCopyRawData	back to summary
private int activeCopyRawData

activeLock	back to summary
private final Object activeLock For managing open/close accounting of `fd`.

activeWindows	back to summary
private int activeWindows

bitmapIdx	back to summary
private Optionally<PackBitmapIndex> bitmapIdx

bitmapIdxFile	back to summary
private volatile PackFile bitmapIdxFile Annotations @Nullable

corruptObjects	back to summary
private volatile LongList corruptObjects Objects we have tried to read, and discovered to be corrupt. The list is allocated after the first corruption is found, and filled in as more entries are discovered. Typically this list is never used, as pack files do not usually contain corrupt objects.

corruptObjects

back to summary

private volatile LongList corruptObjects

Objects we have tried to read, and discovered to be corrupt.

The list is allocated after the first corruption is found, and filled in as more entries are discovered. Typically this list is never used, as pack files do not usually contain corrupt objects.

fd	back to summary
private RandomAccessFile fd

fileSnapshot	back to summary
private PackFileSnapshot fileSnapshot

hash	back to summary
pack-priv final int hash

invalid	back to summary
private volatile boolean invalid

invalidatingCause	back to summary
private volatile Exception invalidatingCause

keepFile	back to summary
private PackFile keepFile

length	back to summary
pack-priv long length

loadedIdx	back to summary
private Optionally<PackIndex> loadedIdx

LOG	back to summary
private static final Logger LOG

packChecksum	back to summary
private byte[] packChecksum

packFile	back to summary
private final PackFile packFile

packLastModified	back to summary
pack-priv Instant packLastModified

readLock	back to summary
private final Object readLock Serializes reads performed against `fd`.

reverseIdx	back to summary
private Optionally<PackReverseIndex> reverseIdx

SORT	back to summary
public static final Comparator<Pack> SORT Sorts PackFiles to be most recently created to least recently created.

transientErrorCount	back to summary
private AtomicInteger transientErrorCount

useStrongRefs	back to summary
private boolean useStrongRefs

Constructor Detail

Pack back to summary

Pack	back to summary
public Pack(Config cfg, File packFile, PackFile bitmapIdxFile) Construct a reader for an existing, pre-indexed packfile. Parameters cfg:Config configuration this directory consults for write settings. packFile:File path of the `.pack` file holding the data. bitmapIdxFile:PackFile existing bitmap index file with the same base as the pack

public Pack(Config cfg, File packFile, PackFile bitmapIdxFile)

Construct a reader for an existing, pre-indexed packfile.

Parameters

cfg:Config: configuration this directory consults for write settings.
packFile:File: path of the .pack file holding the data.
bitmapIdxFile:PackFile: existing bitmap index file with the same base as the pack

Method Detail

beginCopyAsIs	back to summary
private void beginCopyAsIs() throws StoredObjectRepresentationNotAvailableException

beginWindowCache	back to summary
pack-priv boolean beginWindowCache() throws IOException

close	back to summary
public static void close(Set<Pack> packs) Close the resources utilized by these pack files Parameters packs:Set<Pack> packs to close

back to summary

public static void close(Set<Pack> packs)

Close the resources utilized by these pack files

Parameters

packs:Set<Pack>: packs to close

close	back to summary
public void close() Close the resources utilized by this pack file

closeIndices	back to summary
private synchronized void closeIndices()

copyAsIs	back to summary
pack-priv final void copyAsIs(PackOutputStream out, LocalObjectToPack src, boolean validate, WindowCursor curs) throws IOException, StoredObjectRepresentationNotAvailableException

copyAsIs2	back to summary
private void copyAsIs2(PackOutputStream out, LocalObjectToPack src, boolean validate, WindowCursor curs) throws IOException, StoredObjectRepresentationNotAvailableException

copyPackAsIs	back to summary
pack-priv void copyPackAsIs(PackOutputStream out, WindowCursor curs) throws IOException

decompress	back to summary
private final byte[] decompress(final long position, final int sz, final WindowCursor curs) throws IOException, DataFormatException

doClose	back to summary
private void doClose()

doOpen	back to summary
private void doOpen() throws IOException

endCopyAsIs	back to summary
private void endCopyAsIs()

endWindowCache	back to summary
pack-priv boolean endWindowCache()

findDeltaBase	back to summary
private long findDeltaBase(ObjectId baseId) throws IOException, MissingObjectException

findEndOffset	back to summary
private long findEndOffset(long startOffset) throws IOException, CorruptObjectException

findObjectForOffset	back to summary
pack-priv ObjectId findObjectForOffset(long offset) throws IOException Search for object id with the specified start offset in associated pack (reverse) index. Parameters offset:long start offset of object to find Returns:ObjectId object id for this offset, or null if no object was found Exceptions IOException: the index file cannot be loaded into memory.

findObjectForOffset

back to summary

pack-priv ObjectId findObjectForOffset(long offset) throws IOException

Search for object id with the specified start offset in associated pack (reverse) index.

Parameters

offset:long: start offset of object to find

Returns:ObjectId

object id for this offset, or null if no object was found

Exceptions

IOException:: the index file cannot be loaded into memory.

get	back to summary
pack-priv ObjectLoader get(WindowCursor curs, AnyObjectId id) throws IOException Get an object from this pack. Parameters curs:WindowCursor temporary working space associated with the calling thread. id:AnyObjectId the object to obtain from the pack. Must not be null. Returns:ObjectLoader the object loader for the requested object if it is contained in this pack; null if the object was not found. Exceptions IOException: the pack file or the index could not be read.

get

back to summary

pack-priv ObjectLoader get(WindowCursor curs, AnyObjectId id) throws IOException

Get an object from this pack.

Parameters

curs:WindowCursor: temporary working space associated with the calling thread.
id:AnyObjectId: the object to obtain from the pack. Must not be null.

Returns:ObjectLoader

the object loader for the requested object if it is contained in this pack; null if the object was not found.

Exceptions

IOException:: the pack file or the index could not be read.

getBitmapIndex	back to summary
pack-priv synchronized PackBitmapIndex getBitmapIndex() throws IOException

getDeltaHeader	back to summary
pack-priv byte[] getDeltaHeader(WindowCursor wc, long pos) throws IOException, DataFormatException

getFileSnapshot back to summary

getFileSnapshot	back to summary
pack-priv PackFileSnapshot getFileSnapshot() Return the @`FileSnapshot` associated to the underlying packfile that has been used when the object was created. Returns:PackFileSnapshot the packfile @`FileSnapshot` that the object is loaded from.

pack-priv PackFileSnapshot getFileSnapshot()

Return the @FileSnapshot associated to the underlying packfile that has been used when the object was created.

Returns:PackFileSnapshot: the packfile @FileSnapshot that the object is loaded from.

getIndex	back to summary
public PackIndex getIndex() throws IOException Get the index for this pack file. Returns:PackIndex the index for this pack file. Exceptions IOException: if an IO error occurred

getIndex

back to summary

public PackIndex getIndex() throws IOException

Get the index for this pack file.

Returns:PackIndex

the index for this pack file.

Exceptions

IOException:: if an IO error occurred

getObjectCount	back to summary
pack-priv long getObjectCount() throws IOException Obtain the total number of objects available in this pack. This method relies on pack index, giving number of effectively available objects. Returns:long number of objects in index of this pack, likewise in this pack Exceptions IOException: the index file cannot be loaded into memory.

getObjectCount

back to summary

pack-priv long getObjectCount() throws IOException

Obtain the total number of objects available in this pack. This method relies on pack index, giving number of effectively available objects.

Returns:long

number of objects in index of this pack, likewise in this pack

Exceptions

IOException:: the index file cannot be loaded into memory.

getObjectSize	back to summary
pack-priv long getObjectSize(WindowCursor curs, AnyObjectId id) throws IOException

getObjectSize	back to summary
pack-priv long getObjectSize(WindowCursor curs, long pos) throws IOException

getObjectType	back to summary
pack-priv int getObjectType(WindowCursor curs, long pos) throws IOException

getPackChecksum	back to summary
pack-priv AnyObjectId getPackChecksum()

getPackFile

back to summary

public PackFile getPackFile()

Get the File object which locates this pack on disk.

Returns:PackFile: the File object which locates this pack on disk.

getPackName back to summary

public String getPackName()

Get name extracted from pack-*.pack pattern.

Returns:String: name extracted from pack-*.pack pattern.

getReverseIdx	back to summary
private synchronized PackReverseIndex getReverseIdx() throws IOException

hasObject

back to summary

public boolean hasObject(AnyObjectId id) throws IOException

Determine if an object is contained within the pack file.

For performance reasons only the index file is searched; the main pack content is ignored entirely.

Parameters

id:AnyObjectId: the object to look for. Must not be null.

Returns:boolean

true if the object is in this pack; false otherwise.

Exceptions

IOException:: the index file cannot be loaded into memory.

idx	back to summary
private synchronized PackIndex idx() throws IOException

incrementTransientErrorCount	back to summary
pack-priv int incrementTransientErrorCount()

invalid	back to summary
pack-priv boolean invalid()

isCorrupt	back to summary
private boolean isCorrupt(long offset)

iterator back to summary

public Iterator<PackIndex.MutableEntry> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Provide iterator over entries in associated pack index, that should also exist in this pack file. Objects returned by such iterator are mutable during iteration.

Iterator returns objects in SHA-1 lexicographical order.

Returns:Iterator<PackIndex.MutableEntry>

an Iterator.

Annotations

@Override

See Also

PackIndex#iterator()

load	back to summary
pack-priv ObjectLoader load(WindowCursor curs, long pos) throws IOException, LargeObjectException

mmap	back to summary
pack-priv ByteWindow mmap(long pos, int size) throws IOException

onOpenPack	back to summary
private void onOpenPack() throws IOException

openFail	back to summary
private void openFail(Exception cause)

optionally	back to summary
private <T> Optionally<T> optionally(T element)

read	back to summary
pack-priv ByteArrayWindow read(long pos, int size) throws IOException

readFully	back to summary
private void readFully(final long position, final byte[] dstbuf, int dstoff, final int cnt, final WindowCursor curs) throws IOException

representation	back to summary
pack-priv LocalObjectRepresentation representation(final WindowCursor curs, final AnyObjectId objectId) throws IOException

resetTransientErrorCount	back to summary
pack-priv void resetTransientErrorCount()

resolve	back to summary
pack-priv void resolve(Set<ObjectId> matches, AbbreviatedObjectId id, int matchLimit) throws IOException

setBitmapIndexFile	back to summary
pack-priv void setBitmapIndexFile(PackFile bitmapIndexFile)

setCorrupt	back to summary
private void setCorrupt(long offset)

setInvalid	back to summary
pack-priv void setInvalid()

shouldBeKept

back to summary

public boolean shouldBeKept()

Determines whether a .keep file exists for this pack file.

Returns:boolean: true if a .keep file exist.

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@SuppressWarnings:nls
@Override

Modifier and Type	Field and Description
pack-priv final long	basePos Offset of the base object this delta applies onto.
pack-priv final long	deltaPos Offset of the delta object.
pack-priv final int	deltaSize Size of the inflated delta stream.
pack-priv final int	hdrLen Total size of the delta's pack entry header (including base).
pack-priv final Pack.Delta	next Child that applies onto this object.

public Class Pack

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Pack.Delta

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail