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