]>
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 | */ | |
336226c2 | 18 | char *odb_pack_name(struct strbuf *buf, const unsigned char *sha1, const char *ext); |
4f39cd82 JT |
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 | */ | |
336226c2 | 25 | char *sha1_pack_name(const unsigned char *sha1); |
4f39cd82 JT |
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 | */ | |
336226c2 | 32 | char *sha1_pack_index_name(const unsigned char *sha1); |
4f39cd82 | 33 | |
fc789156 JK |
34 | /* |
35 | * Return the basename of the packfile, omitting any containing directory | |
36 | * (e.g., "pack-1234abcd[...].pack"). | |
37 | */ | |
38 | const char *pack_basename(struct packed_git *p); | |
39 | ||
336226c2 | 40 | struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path); |
0317f455 | 41 | |
9208e318 DS |
42 | typedef void each_file_in_pack_dir_fn(const char *full_path, size_t full_path_len, |
43 | const char *file_pach, void *data); | |
44 | void for_each_file_in_pack_dir(const char *objdir, | |
45 | each_file_in_pack_dir_fn fn, | |
46 | void *data); | |
47 | ||
0abe14f6 JT |
48 | /* A hook to report invalid files in pack directory */ |
49 | #define PACKDIR_FILE_PACK 1 | |
50 | #define PACKDIR_FILE_IDX 2 | |
51 | #define PACKDIR_FILE_GARBAGE 4 | |
52 | extern void (*report_garbage)(unsigned seen_bits, const char *path); | |
53 | ||
336226c2 JK |
54 | void reprepare_packed_git(struct repository *r); |
55 | void install_packed_git(struct repository *r, struct packed_git *pack); | |
e65f1862 | 56 | |
a80d72db SB |
57 | struct packed_git *get_packed_git(struct repository *r); |
58 | struct list_head *get_packed_git_mru(struct repository *r); | |
8aac67a1 | 59 | struct multi_pack_index *get_multi_pack_index(struct repository *r); |
59552fb3 | 60 | struct multi_pack_index *get_local_multi_pack_index(struct repository *r); |
0bff5269 | 61 | struct packed_git *get_all_packs(struct repository *r); |
a80d72db | 62 | |
0abe14f6 JT |
63 | /* |
64 | * Give a rough count of objects in the repository. This sacrifices accuracy | |
65 | * for speed. | |
66 | */ | |
5038de19 NTND |
67 | unsigned long repo_approximate_object_count(struct repository *r); |
68 | #define approximate_object_count() repo_approximate_object_count(the_repository) | |
0abe14f6 | 69 | |
336226c2 JK |
70 | struct packed_git *find_sha1_pack(const unsigned char *sha1, |
71 | struct packed_git *packs); | |
d6fe0036 | 72 | |
336226c2 | 73 | void pack_report(void); |
8e21176c | 74 | |
0317f455 JT |
75 | /* |
76 | * mmap the index file for the specified packfile (if it is not | |
77 | * already mmapped). Return 0 on success. | |
78 | */ | |
336226c2 | 79 | int open_pack_index(struct packed_git *); |
0317f455 | 80 | |
3836d88a JT |
81 | /* |
82 | * munmap the index file for the specified packfile (if it is | |
83 | * currently mmapped). | |
84 | */ | |
336226c2 | 85 | void close_pack_index(struct packed_git *); |
3836d88a | 86 | |
5ae18df9 JH |
87 | int close_pack_fd(struct packed_git *p); |
88 | ||
336226c2 | 89 | uint32_t get_pack_fanout(struct packed_git *p, uint32_t value); |
fe1ed56f | 90 | |
336226c2 JK |
91 | unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *); |
92 | void close_pack_windows(struct packed_git *); | |
93 | void close_pack(struct packed_git *); | |
5cb7c735 | 94 | void close_object_store(struct raw_object_store *o); |
336226c2 JK |
95 | void unuse_pack(struct pack_window **); |
96 | void clear_delta_base_cache(void); | |
97 | struct packed_git *add_packed_git(const char *path, size_t path_len, int local); | |
3836d88a | 98 | |
8434e85d DS |
99 | /* |
100 | * Unlink the .pack and associated extension files. | |
101 | * Does not unlink if 'force_delete' is false and the pack-file is | |
102 | * marked as ".keep". | |
103 | */ | |
415b770b | 104 | void unlink_pack_path(const char *pack_name, int force_delete); |
8434e85d | 105 | |
9e0f45f5 JT |
106 | /* |
107 | * Make sure that a pointer access into an mmap'd index file is within bounds, | |
108 | * and can provide at least 8 bytes of data. | |
109 | * | |
110 | * Note that this is only necessary for variable-length segments of the file | |
111 | * (like the 64-bit extended offset table), as we compare the size to the | |
112 | * fixed-length parts when we open the file. | |
113 | */ | |
336226c2 | 114 | void check_pack_index_ptr(const struct packed_git *p, const void *ptr); |
9e0f45f5 | 115 | |
3d475f46 DS |
116 | /* |
117 | * Perform binary search on a pack-index for a given oid. Packfile is expected to | |
118 | * have a valid pack-index. | |
119 | * | |
120 | * See 'bsearch_hash' for more information. | |
121 | */ | |
122 | int bsearch_pack(const struct object_id *oid, const struct packed_git *p, uint32_t *result); | |
123 | ||
d5a16761 | 124 | /* |
2fecc48c JK |
125 | * Write the oid of the nth object within the specified packfile into the first |
126 | * parameter. Open the index if it is not already open. Returns 0 on success, | |
127 | * negative otherwise. | |
d5a16761 | 128 | */ |
0763671b | 129 | int nth_packed_object_id(struct object_id *, struct packed_git *, uint32_t n); |
d5a16761 | 130 | |
9e0f45f5 JT |
131 | /* |
132 | * Return the offset of the nth object within the specified packfile. | |
133 | * The index must already be opened. | |
134 | */ | |
336226c2 | 135 | off_t nth_packed_object_offset(const struct packed_git *, uint32_t n); |
d5a16761 | 136 | |
a2551953 JT |
137 | /* |
138 | * If the object named sha1 is present in the specified packfile, | |
139 | * return its offset within the packfile; otherwise, return 0. | |
140 | */ | |
336226c2 | 141 | off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *); |
a2551953 | 142 | |
336226c2 JK |
143 | int is_pack_valid(struct packed_git *); |
144 | void *unpack_entry(struct repository *r, struct packed_git *, off_t, enum object_type *, unsigned long *); | |
145 | unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep); | |
146 | unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t); | |
147 | int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *); | |
56d9cbe6 JK |
148 | off_t get_delta_base(struct packed_git *p, struct pack_window **w_curs, |
149 | off_t *curpos, enum object_type type, | |
150 | off_t delta_obj_offset); | |
32b42e15 | 151 | |
336226c2 | 152 | void release_pack_memory(size_t); |
f0e17e86 | 153 | |
f1d8130b JT |
154 | /* global flag to enable extra checks when accessing packed objects */ |
155 | extern int do_check_packed_object_crc; | |
156 | ||
336226c2 JK |
157 | int packed_object_info(struct repository *r, |
158 | struct packed_git *pack, | |
159 | off_t offset, struct object_info *); | |
f1d8130b | 160 | |
751530de | 161 | void mark_bad_packed_object(struct packed_git *, const struct object_id *); |
7407d733 | 162 | const struct packed_git *has_packed_and_bad(struct repository *, const struct object_id *); |
9e0f45f5 | 163 | |
f62312e0 TB |
164 | #define ON_DISK_KEEP_PACKS 1 |
165 | #define IN_CORE_KEEP_PACKS 2 | |
166 | ||
613b42f2 SB |
167 | /* |
168 | * Iff a pack file in the given repository contains the object named by sha1, | |
169 | * return true and store its location to e. | |
170 | */ | |
336226c2 | 171 | int find_pack_entry(struct repository *r, const struct object_id *oid, struct pack_entry *e); |
f62312e0 | 172 | int find_kept_pack_entry(struct repository *r, const struct object_id *oid, unsigned flags, struct pack_entry *e); |
1a1e5d4f | 173 | |
336226c2 | 174 | int has_object_pack(const struct object_id *oid); |
f62312e0 | 175 | int has_object_kept_pack(const struct object_id *oid, unsigned flags); |
150e3001 | 176 | |
336226c2 | 177 | int has_pack_index(const unsigned char *sha1); |
f9a8672a | 178 | |
498f1f61 JT |
179 | /* |
180 | * Return 1 if an object in a promisor packfile is or refers to the given | |
181 | * object, 0 otherwise. | |
182 | */ | |
336226c2 | 183 | int is_promisor_object(const struct object_id *oid); |
498f1f61 | 184 | |
1127a98c JS |
185 | /* |
186 | * Expose a function for fuzz testing. | |
187 | * | |
188 | * load_idx() parses a block of memory as a packfile index and puts the results | |
189 | * into a struct packed_git. | |
190 | * | |
191 | * This function should not be used directly. It is exposed here only so that we | |
192 | * have a convenient entry-point for fuzz testing. For real uses, you should | |
193 | * probably use open_pack_index() or parse_pack_index() instead. | |
194 | */ | |
336226c2 JK |
195 | int load_idx(const char *path, const unsigned int hashsz, void *idx_map, |
196 | size_t idx_size, struct packed_git *p); | |
1127a98c | 197 | |
4f39cd82 | 198 | #endif |