git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Steven E. Harris" <seh@panix.com>
To: git@vger.kernel.org
Subject: Confused over packfile and index design
Date: Fri, 08 Apr 2011 19:58:41 -0400	[thread overview]
Message-ID: <m2d3kw70su.fsf@Spindle.sehlabs.com> (raw)

I was reading the Git Book discussion¹ on the packfile and index formats,
and there's a confusing set of assertions concerning the design choices
that sound contradictory.

First, near the end of the section about the index format, we find the
following paragraph:

,----
| Importantly, packfile indexes are /not/ neccesary to extract objects
| from a packfile, they are simply used to quickly retrieve individual
| objects from a pack. The packfile format is used in upload-pack and
| receieve-pack programs (push and fetch protocols) to transfer objects
| and there is no index used then - it can be built after the fact by
| scanning the packfile.
`----

That suggests that it's possible to read the packfile linearly and
deduce where the various objects start and end, without the index
available.

Later, in the section on the packfile format, we find this:

,----
| It is important to note that the size specified in the header data is
| not the size of the data that actually follows, but the size of that
| data /when expanded/. This is why the offsets in the packfile index are
| so useful, otherwise you have to expand every object just to tell when
| the next header starts.
`----

Now that makes it sound like without the index, even if one knows where
a packed object starts, reading its header tells its /inflated/ size,
/not/ the number of remaining payload bytes representing the object. If
that's true, then how does one figure out where one object ends and the
next one begins /without the index/?

Recall that the first paragraph quoted above says that the index can be
built from the packfile, as opposed to it being essential to reading the
packfile. Is one of these paragraphs incorrect?

The Git documentation on the pack format² mentions that the packed
object headers represent the lengths as variable-sized integers

,----
| n-byte type and length (3-bit type, (n-1)*7+4-bit length)
`----

but it doesn't say whether that's the number of (deflated) payload bytes
or the inflated object size, as the Git Book asserts.

I imagine that if the format is meant to record the size of the deflated
payload, then it would be challenging to compress the data straight into
the packfile, because one wouldn't know the final size until it was
written, which means that one wouldn't know how many bytes will be
necessary to write its length in the header, which means one wouldn't
know where to start writing the deflated payload.

Are there any other clarifying documents you can recommend to understand
the design?


Footnotes: 
¹ http://book.git-scm.com/7_the_packfile.html
² http://www.kernel.org/pub/software/scm/git/docs/technical/pack-format.txt

-- 
Steven E. Harris

             reply	other threads:[~2011-04-08 23:59 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-04-08 23:58 Steven E. Harris [this message]
2011-04-09  0:20 ` Confused over packfile and index design Jeff King
2011-04-09  2:07 ` Shawn Pearce
2011-04-09 14:30   ` Steven E. Harris
2011-04-09 14:45     ` Shawn Pearce
2011-04-10  2:08 ` Nicolas Pitre
2011-04-10 20:10   ` Steven E. Harris

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=m2d3kw70su.fsf@Spindle.sehlabs.com \
    --to=seh@panix.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).