]>
Commit | Line | Data |
---|---|---|
4f39cd82 JT |
1 | #ifndef PACKFILE_H |
2 | #define PACKFILE_H | |
3 | ||
b42f98af | 4 | #include "cache.h" |
498f1f61 JT |
5 | #include "oidset.h" |
6 | ||
cbd53a21 SB |
7 | /* in object-store.h */ |
8 | struct packed_git; | |
9 | struct object_info; | |
cbd53a21 | 10 | |
4f39cd82 JT |
11 | /* |
12 | * Generate the filename to be used for a pack file with checksum "sha1" and | |
13 | * extension "ext". The result is written into the strbuf "buf", overwriting | |
14 | * any existing contents. A pointer to buf->buf is returned as a convenience. | |
15 | * | |
16 | * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx" | |
17 | */ | |
18 | extern char *odb_pack_name(struct strbuf *buf, const unsigned char *sha1, const char *ext); | |
19 | ||
20 | /* | |
21 | * Return the name of the (local) packfile with the specified sha1 in | |
22 | * its name. The return value is a pointer to memory that is | |
23 | * overwritten each time this function is called. | |
24 | */ | |
25 | extern char *sha1_pack_name(const unsigned char *sha1); | |
26 | ||
27 | /* | |
28 | * Return the name of the (local) pack index file with the specified | |
29 | * sha1 in its name. The return value is a pointer to memory that is | |
30 | * overwritten each time this function is called. | |
31 | */ | |
32 | extern char *sha1_pack_index_name(const unsigned char *sha1); | |
33 | ||
0317f455 JT |
34 | extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path); |
35 | ||
0abe14f6 JT |
36 | /* A hook to report invalid files in pack directory */ |
37 | #define PACKDIR_FILE_PACK 1 | |
38 | #define PACKDIR_FILE_IDX 2 | |
39 | #define PACKDIR_FILE_GARBAGE 4 | |
40 | extern void (*report_garbage)(unsigned seen_bits, const char *path); | |
41 | ||
4c2a13b4 | 42 | extern void reprepare_packed_git(struct repository *r); |
5babff16 | 43 | extern void install_packed_git(struct repository *r, struct packed_git *pack); |
e65f1862 | 44 | |
a80d72db SB |
45 | struct packed_git *get_packed_git(struct repository *r); |
46 | struct list_head *get_packed_git_mru(struct repository *r); | |
47 | ||
0abe14f6 JT |
48 | /* |
49 | * Give a rough count of objects in the repository. This sacrifices accuracy | |
50 | * for speed. | |
51 | */ | |
52 | unsigned long approximate_object_count(void); | |
53 | ||
d6fe0036 JT |
54 | extern struct packed_git *find_sha1_pack(const unsigned char *sha1, |
55 | struct packed_git *packs); | |
56 | ||
8e21176c JT |
57 | extern void pack_report(void); |
58 | ||
0317f455 JT |
59 | /* |
60 | * mmap the index file for the specified packfile (if it is not | |
61 | * already mmapped). Return 0 on success. | |
62 | */ | |
63 | extern int open_pack_index(struct packed_git *); | |
64 | ||
3836d88a JT |
65 | /* |
66 | * munmap the index file for the specified packfile (if it is | |
67 | * currently mmapped). | |
68 | */ | |
69 | extern void close_pack_index(struct packed_git *); | |
70 | ||
84f80ad5 | 71 | extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *); |
3836d88a | 72 | extern void close_pack_windows(struct packed_git *); |
049d51a2 | 73 | extern void close_pack(struct packed_git *); |
d0b59866 | 74 | extern void close_all_packs(struct raw_object_store *o); |
97de1803 | 75 | extern void unuse_pack(struct pack_window **); |
f1d8130b | 76 | extern void clear_delta_base_cache(void); |
9a428653 | 77 | extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local); |
3836d88a | 78 | |
9e0f45f5 JT |
79 | /* |
80 | * Make sure that a pointer access into an mmap'd index file is within bounds, | |
81 | * and can provide at least 8 bytes of data. | |
82 | * | |
83 | * Note that this is only necessary for variable-length segments of the file | |
84 | * (like the 64-bit extended offset table), as we compare the size to the | |
85 | * fixed-length parts when we open the file. | |
86 | */ | |
87 | extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr); | |
88 | ||
3d475f46 DS |
89 | /* |
90 | * Perform binary search on a pack-index for a given oid. Packfile is expected to | |
91 | * have a valid pack-index. | |
92 | * | |
93 | * See 'bsearch_hash' for more information. | |
94 | */ | |
95 | int bsearch_pack(const struct object_id *oid, const struct packed_git *p, uint32_t *result); | |
96 | ||
d5a16761 JT |
97 | /* |
98 | * Return the SHA-1 of the nth object within the specified packfile. | |
99 | * Open the index if it is not already open. The return value points | |
100 | * at the SHA-1 within the mmapped index. Return NULL if there is an | |
101 | * error. | |
102 | */ | |
103 | extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n); | |
104 | /* | |
105 | * Like nth_packed_object_sha1, but write the data into the object specified by | |
106 | * the the first argument. Returns the first argument on success, and NULL on | |
107 | * error. | |
108 | */ | |
109 | extern const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n); | |
110 | ||
9e0f45f5 JT |
111 | /* |
112 | * Return the offset of the nth object within the specified packfile. | |
113 | * The index must already be opened. | |
114 | */ | |
115 | extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n); | |
d5a16761 | 116 | |
a2551953 JT |
117 | /* |
118 | * If the object named sha1 is present in the specified packfile, | |
119 | * return its offset within the packfile; otherwise, return 0. | |
120 | */ | |
121 | extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *); | |
122 | ||
123 | extern int is_pack_valid(struct packed_git *); | |
9d98354f | 124 | extern void *unpack_entry(struct repository *r, struct packed_git *, off_t, enum object_type *, unsigned long *); |
32b42e15 | 125 | extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep); |
7b3aa75d | 126 | extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t); |
3588dd6e | 127 | extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *); |
32b42e15 | 128 | |
f0e17e86 JT |
129 | extern void release_pack_memory(size_t); |
130 | ||
f1d8130b JT |
131 | /* global flag to enable extra checks when accessing packed objects */ |
132 | extern int do_check_packed_object_crc; | |
133 | ||
9d98354f SB |
134 | extern int packed_object_info(struct repository *r, |
135 | struct packed_git *pack, | |
136 | off_t offset, struct object_info *); | |
f1d8130b JT |
137 | |
138 | extern void mark_bad_packed_object(struct packed_git *p, const unsigned char *sha1); | |
139 | extern const struct packed_git *has_packed_and_bad(const unsigned char *sha1); | |
9e0f45f5 | 140 | |
613b42f2 SB |
141 | /* |
142 | * Iff a pack file in the given repository contains the object named by sha1, | |
143 | * return true and store its location to e. | |
144 | */ | |
544443cb | 145 | extern int find_pack_entry(struct repository *r, const struct object_id *oid, struct pack_entry *e); |
1a1e5d4f | 146 | |
14c3c80c | 147 | extern int has_object_pack(const struct object_id *oid); |
150e3001 | 148 | |
f9a8672a JT |
149 | extern int has_pack_index(const unsigned char *sha1); |
150 | ||
498f1f61 JT |
151 | /* |
152 | * Return 1 if an object in a promisor packfile is or refers to the given | |
153 | * object, 0 otherwise. | |
154 | */ | |
155 | extern int is_promisor_object(const struct object_id *oid); | |
156 | ||
4f39cd82 | 157 | #endif |