2 * Copyright (C) the libgit2 contributors. All rights reserved.
4 * This file is part of libgit2, distributed under the GNU GPL v2 with
5 * a Linking Exception. For full terms see the included COPYING file.
8 #ifndef INCLUDE_pack_h__
9 #define INCLUDE_pack_h__
21 #define GIT_PACK_FILE_MODE 0444
23 #define PACK_SIGNATURE 0x5041434b /* "PACK" */
24 #define PACK_VERSION 2
25 #define pack_version_ok(v) ((v) == htonl(2) || (v) == htonl(3))
26 struct git_pack_header
{
27 uint32_t hdr_signature
;
33 * The first four bytes of index formats later than version 1 should
34 * start with this signature, as all older git binaries would find this
35 * value illegal and abort reading the file.
37 * This is the case because the number of objects in a packfile
38 * cannot exceed 1,431,660,000 as every object would need at least
39 * 3 bytes of data and the overall packfile cannot exceed 4 GiB with
40 * version 1 of the index file due to the offsets limited to 32 bits.
41 * Clearly the signature exceeds this maximum.
43 * Very old git binaries will also compare the first 4 bytes to the
44 * next 4 bytes in the index and abort with a "non-monotonic index"
45 * error if the second 4 byte word is smaller than the first 4
46 * byte word. This would be true in the proposed future index
47 * format as idx_signature would be greater than idx_version.
50 #define PACK_IDX_SIGNATURE 0xff744f63 /* "\377tOc" */
52 struct git_pack_idx_header
{
53 uint32_t idx_signature
;
57 typedef struct git_pack_cache_entry
{
58 size_t last_usage
; /* enough? */
61 } git_pack_cache_entry
;
68 #define GIT_PACK_CACHE_MEMORY_LIMIT 16 * 1024 * 1024
69 #define GIT_PACK_CACHE_SIZE_LIMIT 1024 * 1024 /* don't bother caching anything over 1MB */
79 struct git_pack_file
{
82 git_mutex lock
; /* protect updates to mwf and index_map */
85 uint32_t num_bad_objects
;
86 git_oid
*bad_object_sha1
; /* array of git_oid */
90 unsigned pack_local
:1, pack_keep
:1, has_cache
:1;
92 git_oidmap
*idx_cache
;
95 git_pack_cache bases
; /* delta base cache */
97 /* something like ".git/objects/pack/xxxxx.pack" */
98 char pack_name
[GIT_FLEX_ARRAY
]; /* more */
101 struct git_pack_entry
{
104 struct git_pack_file
*p
;
107 typedef struct git_packfile_stream
{
111 struct git_pack_file
*p
;
113 } git_packfile_stream
;
115 int git_packfile__object_header(unsigned char *hdr
, size_t size
, git_otype type
);
117 int git_packfile_unpack_header(
120 git_mwindow_file
*mwf
,
121 git_mwindow
**w_curs
,
124 int git_packfile_resolve_header(
127 struct git_pack_file
*p
,
130 int git_packfile_unpack(git_rawobj
*obj
, struct git_pack_file
*p
, git_off_t
*obj_offset
);
131 int packfile_unpack_compressed(
133 struct git_pack_file
*p
,
134 git_mwindow
**w_curs
,
139 int git_packfile_stream_open(git_packfile_stream
*obj
, struct git_pack_file
*p
, git_off_t curpos
);
140 ssize_t
git_packfile_stream_read(git_packfile_stream
*obj
, void *buffer
, size_t len
);
141 void git_packfile_stream_free(git_packfile_stream
*obj
);
143 git_off_t
get_delta_base(struct git_pack_file
*p
, git_mwindow
**w_curs
,
144 git_off_t
*curpos
, git_otype type
,
145 git_off_t delta_obj_offset
);
147 void git_packfile_free(struct git_pack_file
*p
);
148 int git_packfile_alloc(struct git_pack_file
**pack_out
, const char *path
);
150 int git_pack_entry_find(
151 struct git_pack_entry
*e
,
152 struct git_pack_file
*p
,
153 const git_oid
*short_oid
,
155 int git_pack_foreach_entry(
156 struct git_pack_file
*p
,
157 git_odb_foreach_cb cb
,