]>
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 | ||
9208e318 DS |
36 | typedef void each_file_in_pack_dir_fn(const char *full_path, size_t full_path_len, |
37 | const char *file_pach, void *data); | |
38 | void for_each_file_in_pack_dir(const char *objdir, | |
39 | each_file_in_pack_dir_fn fn, | |
40 | void *data); | |
41 | ||
0abe14f6 JT |
42 | /* A hook to report invalid files in pack directory */ |
43 | #define PACKDIR_FILE_PACK 1 | |
44 | #define PACKDIR_FILE_IDX 2 | |
45 | #define PACKDIR_FILE_GARBAGE 4 | |
46 | extern void (*report_garbage)(unsigned seen_bits, const char *path); | |
47 | ||
4c2a13b4 | 48 | extern void reprepare_packed_git(struct repository *r); |
5babff16 | 49 | extern void install_packed_git(struct repository *r, struct packed_git *pack); |
e65f1862 | 50 | |
a80d72db SB |
51 | struct packed_git *get_packed_git(struct repository *r); |
52 | struct list_head *get_packed_git_mru(struct repository *r); | |
8aac67a1 | 53 | struct multi_pack_index *get_multi_pack_index(struct repository *r); |
0bff5269 | 54 | struct packed_git *get_all_packs(struct repository *r); |
a80d72db | 55 | |
0abe14f6 JT |
56 | /* |
57 | * Give a rough count of objects in the repository. This sacrifices accuracy | |
58 | * for speed. | |
59 | */ | |
60 | unsigned long approximate_object_count(void); | |
61 | ||
d6fe0036 JT |
62 | extern struct packed_git *find_sha1_pack(const unsigned char *sha1, |
63 | struct packed_git *packs); | |
64 | ||
8e21176c JT |
65 | extern void pack_report(void); |
66 | ||
0317f455 JT |
67 | /* |
68 | * mmap the index file for the specified packfile (if it is not | |
69 | * already mmapped). Return 0 on success. | |
70 | */ | |
71 | extern int open_pack_index(struct packed_git *); | |
72 | ||
3836d88a JT |
73 | /* |
74 | * munmap the index file for the specified packfile (if it is | |
75 | * currently mmapped). | |
76 | */ | |
77 | extern void close_pack_index(struct packed_git *); | |
78 | ||
fe1ed56f DS |
79 | extern uint32_t get_pack_fanout(struct packed_git *p, uint32_t value); |
80 | ||
84f80ad5 | 81 | extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *); |
3836d88a | 82 | extern void close_pack_windows(struct packed_git *); |
049d51a2 | 83 | extern void close_pack(struct packed_git *); |
d0b59866 | 84 | extern void close_all_packs(struct raw_object_store *o); |
97de1803 | 85 | extern void unuse_pack(struct pack_window **); |
f1d8130b | 86 | extern void clear_delta_base_cache(void); |
9a428653 | 87 | extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local); |
3836d88a | 88 | |
9e0f45f5 JT |
89 | /* |
90 | * Make sure that a pointer access into an mmap'd index file is within bounds, | |
91 | * and can provide at least 8 bytes of data. | |
92 | * | |
93 | * Note that this is only necessary for variable-length segments of the file | |
94 | * (like the 64-bit extended offset table), as we compare the size to the | |
95 | * fixed-length parts when we open the file. | |
96 | */ | |
97 | extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr); | |
98 | ||
3d475f46 DS |
99 | /* |
100 | * Perform binary search on a pack-index for a given oid. Packfile is expected to | |
101 | * have a valid pack-index. | |
102 | * | |
103 | * See 'bsearch_hash' for more information. | |
104 | */ | |
105 | int bsearch_pack(const struct object_id *oid, const struct packed_git *p, uint32_t *result); | |
106 | ||
d5a16761 JT |
107 | /* |
108 | * Return the SHA-1 of the nth object within the specified packfile. | |
109 | * Open the index if it is not already open. The return value points | |
110 | * at the SHA-1 within the mmapped index. Return NULL if there is an | |
111 | * error. | |
112 | */ | |
113 | extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n); | |
114 | /* | |
115 | * Like nth_packed_object_sha1, but write the data into the object specified by | |
116 | * the the first argument. Returns the first argument on success, and NULL on | |
117 | * error. | |
118 | */ | |
119 | extern const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n); | |
120 | ||
9e0f45f5 JT |
121 | /* |
122 | * Return the offset of the nth object within the specified packfile. | |
123 | * The index must already be opened. | |
124 | */ | |
125 | extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n); | |
d5a16761 | 126 | |
a2551953 JT |
127 | /* |
128 | * If the object named sha1 is present in the specified packfile, | |
129 | * return its offset within the packfile; otherwise, return 0. | |
130 | */ | |
131 | extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *); | |
132 | ||
133 | extern int is_pack_valid(struct packed_git *); | |
9d98354f | 134 | extern void *unpack_entry(struct repository *r, struct packed_git *, off_t, enum object_type *, unsigned long *); |
32b42e15 | 135 | extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep); |
7b3aa75d | 136 | extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t); |
3588dd6e | 137 | extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *); |
32b42e15 | 138 | |
f0e17e86 JT |
139 | extern void release_pack_memory(size_t); |
140 | ||
f1d8130b JT |
141 | /* global flag to enable extra checks when accessing packed objects */ |
142 | extern int do_check_packed_object_crc; | |
143 | ||
9d98354f SB |
144 | extern int packed_object_info(struct repository *r, |
145 | struct packed_git *pack, | |
146 | off_t offset, struct object_info *); | |
f1d8130b JT |
147 | |
148 | extern void mark_bad_packed_object(struct packed_git *p, const unsigned char *sha1); | |
149 | extern const struct packed_git *has_packed_and_bad(const unsigned char *sha1); | |
9e0f45f5 | 150 | |
613b42f2 SB |
151 | /* |
152 | * Iff a pack file in the given repository contains the object named by sha1, | |
153 | * return true and store its location to e. | |
154 | */ | |
544443cb | 155 | extern int find_pack_entry(struct repository *r, const struct object_id *oid, struct pack_entry *e); |
1a1e5d4f | 156 | |
14c3c80c | 157 | extern int has_object_pack(const struct object_id *oid); |
150e3001 | 158 | |
f9a8672a JT |
159 | extern int has_pack_index(const unsigned char *sha1); |
160 | ||
498f1f61 JT |
161 | /* |
162 | * Return 1 if an object in a promisor packfile is or refers to the given | |
163 | * object, 0 otherwise. | |
164 | */ | |
165 | extern int is_promisor_object(const struct object_id *oid); | |
166 | ||
1127a98c JS |
167 | /* |
168 | * Expose a function for fuzz testing. | |
169 | * | |
170 | * load_idx() parses a block of memory as a packfile index and puts the results | |
171 | * into a struct packed_git. | |
172 | * | |
173 | * This function should not be used directly. It is exposed here only so that we | |
174 | * have a convenient entry-point for fuzz testing. For real uses, you should | |
175 | * probably use open_pack_index() or parse_pack_index() instead. | |
176 | */ | |
177 | extern int load_idx(const char *path, const unsigned int hashsz, void *idx_map, | |
178 | size_t idx_size, struct packed_git *p); | |
179 | ||
4f39cd82 | 180 | #endif |