commitgraph

Documentation

Overview

Package commitgraph implements encoding and decoding of commit-graph files.

Git commit graph format =======================

The Git commit graph stores a list of commit OIDs and some associated metadata, including:

• The generation number of the commit. Commits with no parents have generation number 1; commits with parents have generation number one more than the maximum generation number of its parents. We reserve zero as special, and can be used to mark a generation number invalid or as "not computed".

- The root tree OID.

- The commit date.

• The parents of the commit, stored using positional references within the graph file.

These positional references are stored as unsigned 32-bit integers corresponding to the array position within the list of commit OIDs. Due to some special constants we use to track parents, we can store at most (1 << 30) + (1 << 29) + (1 << 28) - 1 (around 1.8 billion) commits.

== Commit graph files have the following format:

In order to allow extensions that add extra data to the graph, we organize the body into "chunks" and provide a binary lookup table at the beginning of the body. The header includes certain values, such as number of chunks and hash type.

All 4-byte numbers are in network order.

HEADER:

4-byte signature:
    The signature is: {'C', 'G', 'P', 'H'}

1-byte version number:
    Currently, the only valid version is 1.

1-byte Hash Version (1 = SHA-1)
    We infer the hash length (H) from this value.

1-byte number (C) of "chunks"

1-byte (reserved for later use)
   Current clients should ignore this value.

CHUNK LOOKUP:

(C + 1) * 12 bytes listing the table of contents for the chunks:
    First 4 bytes describe the chunk id. Value 0 is a terminating label.
    Other 8 bytes provide the byte-offset in current file for chunk to
    start. (Chunks are ordered contiguously in the file, so you can infer
    the length using the next chunk position if necessary.) Each chunk
    ID appears at most once.

The remaining data in the body is described one chunk at a time, and
these chunks may be given in any order. Chunks are required unless
otherwise specified.

CHUNK DATA:

OID Fanout (ID: {'O', 'I', 'D', 'F'}) (256 * 4 bytes)
    The ith entry, F[i], stores the number of OIDs with first
    byte at most i. Thus F[255] stores the total
    number of commits (N).

OID Lookup (ID: {'O', 'I', 'D', 'L'}) (N * H bytes)
    The OIDs for all commits in the graph, sorted in ascending order.

Commit Data (ID: {'C', 'D', 'A', 'T' }) (N * (H + 16) bytes)
  * The first H bytes are for the OID of the root tree.
  * The next 8 bytes are for the positions of the first two parents
    of the ith commit. Stores value 0x7000000 if no parent in that
    position. If there are more than two parents, the second value
    has its most-significant bit on and the other bits store an array
    position into the Extra Edge List chunk.
  * The next 8 bytes store the generation number of the commit and
    the commit time in seconds since EPOCH. The generation number
    uses the higher 30 bits of the first 4 bytes, while the commit
    time uses the 32 bits of the second 4 bytes, along with the lowest
    2 bits of the lowest byte, storing the 33rd and 34th bit of the
    commit time.

Extra Edge List (ID: {'E', 'D', 'G', 'E'}) [Optional]
    This list of 4-byte values store the second through nth parents for
    all octopus merges. The second parent value in the commit data stores
    an array position within this list along with the most-significant bit
    on. Starting at that array position, iterate through this list of commit
    positions for the parents until reaching a value with the most-significant
    bit on. The other bits correspond to the position of the last parent.

TRAILER:

H-byte HASH-checksum of all of the above.

Source: https://raw.githubusercontent.com/git/git/master/Documentation/technical/commit-graph-format.txt

Index

• Variables
• type CommitData
• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func (e *Encoder) Encode(idx Index) error
• type Index
  • func OpenFileIndex(reader io.ReaderAt) (Index, error)
• type MemoryIndex
  • func NewMemoryIndex() *MemoryIndex
  • func (mi *MemoryIndex) Add(hash plumbing.Hash, commitData *CommitData)
  • func (mi *MemoryIndex) GetCommitDataByIndex(i int) (*CommitData, error)
  • func (mi *MemoryIndex) GetIndexByHash(h plumbing.Hash) (int, error)
  • func (mi *MemoryIndex) Hashes() []plumbing.Hash

Variables

var (
	// ErrUnsupportedVersion is returned by OpenFileIndex when the commit graph
	// file version is not supported.
	ErrUnsupportedVersion = errors.New("unsupported version")
	// ErrUnsupportedHash is returned by OpenFileIndex when the commit graph
	// hash function is not supported. Currently only SHA-1 is defined and
	// supported
	ErrUnsupportedHash = errors.New("unsupported hash algorithm")
	// ErrMalformedCommitGraphFile is returned by OpenFileIndex when the commit
	// graph file is corrupted.
	ErrMalformedCommitGraphFile = errors.New("malformed commit graph file")
)

Types

type CommitData

type CommitData struct {
	// TreeHash is the hash of the root tree of the commit.
	TreeHash plumbing.Hash
	// ParentIndexes are the indexes of the parent commits of the commit.
	ParentIndexes []int
	// ParentHashes are the hashes of the parent commits of the commit.
	ParentHashes []plumbing.Hash
	// Generation number is the pre-computed generation in the commit graph
	// or zero if not available
	Generation int
	// When is the timestamp of the commit.
	When time.Time
}

CommitData is a reduced representation of Commit as presented in the commit graph file. It is merely useful as an optimization for walking the commit graphs.

type Encoder

type Encoder struct {
	io.Writer
	// contains filtered or unexported fields
}

Encoder writes MemoryIndex structs to an output stream.

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

NewEncoder returns a new stream encoder that writes to w.

func (*Encoder) Encode

func (e *Encoder) Encode(idx Index) error

Encode writes an index into the commit-graph file

type Index

type Index interface {
	// GetIndexByHash gets the index in the commit graph from commit hash, if available
	GetIndexByHash(h plumbing.Hash) (int, error)
	// GetNodeByIndex gets the commit node from the commit graph using index
	// obtained from child node, if available
	GetCommitDataByIndex(i int) (*CommitData, error)
	// Hashes returns all the hashes that are available in the index
	Hashes() []plumbing.Hash
}

Index represents a representation of commit graph that allows indexed access to the nodes using commit object hash

func OpenFileIndex

func OpenFileIndex(reader io.ReaderAt) (Index, error)

OpenFileIndex opens a serialized commit graph file in the format described at https://github.com/git/git/blob/master/Documentation/technical/commit-graph-format.txt

type MemoryIndex

type MemoryIndex struct {
	// contains filtered or unexported fields
}

MemoryIndex provides a way to build the commit-graph in memory for later encoding to file.

func NewMemoryIndex

func NewMemoryIndex() *MemoryIndex

NewMemoryIndex creates in-memory commit graph representation

func (*MemoryIndex) Add

func (mi *MemoryIndex) Add(hash plumbing.Hash, commitData *CommitData)

Add adds new node to the memory index

func (*MemoryIndex) GetCommitDataByIndex

func (mi *MemoryIndex) GetCommitDataByIndex(i int) (*CommitData, error)

GetCommitDataByIndex gets the commit node from the commit graph using index obtained from child node, if available

func (*MemoryIndex) GetIndexByHash

func (mi *MemoryIndex) GetIndexByHash(h plumbing.Hash) (int, error)

GetIndexByHash gets the index in the commit graph from commit hash, if available

func (*MemoryIndex) Hashes

func (mi *MemoryIndex) Hashes() []plumbing.Hash

Hashes returns all the hashes that are available in the index