]>
Commit | Line | Data |
---|---|---|
1 | #ifndef PACKFILE_H | |
2 | #define PACKFILE_H | |
3 | ||
4 | #include "cache.h" | |
5 | #include "oidset.h" | |
6 | ||
7 | /* in object-store.h */ | |
8 | struct packed_git; | |
9 | struct object_info; | |
10 | ||
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 | 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 | 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 | char *sha1_pack_index_name(const unsigned char *sha1); | |
33 | ||
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 | ||
40 | struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path); | |
41 | ||
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 | ||
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 | ||
54 | void reprepare_packed_git(struct repository *r); | |
55 | void install_packed_git(struct repository *r, struct packed_git *pack); | |
56 | ||
57 | struct packed_git *get_packed_git(struct repository *r); | |
58 | struct list_head *get_packed_git_mru(struct repository *r); | |
59 | struct multi_pack_index *get_multi_pack_index(struct repository *r); | |
60 | struct packed_git *get_all_packs(struct repository *r); | |
61 | ||
62 | /* | |
63 | * Give a rough count of objects in the repository. This sacrifices accuracy | |
64 | * for speed. | |
65 | */ | |
66 | unsigned long repo_approximate_object_count(struct repository *r); | |
67 | #define approximate_object_count() repo_approximate_object_count(the_repository) | |
68 | ||
69 | struct packed_git *find_sha1_pack(const unsigned char *sha1, | |
70 | struct packed_git *packs); | |
71 | ||
72 | void pack_report(void); | |
73 | ||
74 | /* | |
75 | * mmap the index file for the specified packfile (if it is not | |
76 | * already mmapped). Return 0 on success. | |
77 | */ | |
78 | int open_pack_index(struct packed_git *); | |
79 | ||
80 | /* | |
81 | * munmap the index file for the specified packfile (if it is | |
82 | * currently mmapped). | |
83 | */ | |
84 | void close_pack_index(struct packed_git *); | |
85 | ||
86 | int close_pack_fd(struct packed_git *p); | |
87 | ||
88 | uint32_t get_pack_fanout(struct packed_git *p, uint32_t value); | |
89 | ||
90 | unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *); | |
91 | void close_pack_windows(struct packed_git *); | |
92 | void close_pack(struct packed_git *); | |
93 | void close_object_store(struct raw_object_store *o); | |
94 | void unuse_pack(struct pack_window **); | |
95 | void clear_delta_base_cache(void); | |
96 | struct packed_git *add_packed_git(const char *path, size_t path_len, int local); | |
97 | ||
98 | /* | |
99 | * Unlink the .pack and associated extension files. | |
100 | * Does not unlink if 'force_delete' is false and the pack-file is | |
101 | * marked as ".keep". | |
102 | */ | |
103 | void unlink_pack_path(const char *pack_name, int force_delete); | |
104 | ||
105 | /* | |
106 | * Make sure that a pointer access into an mmap'd index file is within bounds, | |
107 | * and can provide at least 8 bytes of data. | |
108 | * | |
109 | * Note that this is only necessary for variable-length segments of the file | |
110 | * (like the 64-bit extended offset table), as we compare the size to the | |
111 | * fixed-length parts when we open the file. | |
112 | */ | |
113 | void check_pack_index_ptr(const struct packed_git *p, const void *ptr); | |
114 | ||
115 | /* | |
116 | * Perform binary search on a pack-index for a given oid. Packfile is expected to | |
117 | * have a valid pack-index. | |
118 | * | |
119 | * See 'bsearch_hash' for more information. | |
120 | */ | |
121 | int bsearch_pack(const struct object_id *oid, const struct packed_git *p, uint32_t *result); | |
122 | ||
123 | /* | |
124 | * Return the SHA-1 of the nth object within the specified packfile. | |
125 | * Open the index if it is not already open. The return value points | |
126 | * at the SHA-1 within the mmapped index. Return NULL if there is an | |
127 | * error. | |
128 | */ | |
129 | const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n); | |
130 | /* | |
131 | * Like nth_packed_object_sha1, but write the data into the object specified by | |
132 | * the the first argument. Returns the first argument on success, and NULL on | |
133 | * error. | |
134 | */ | |
135 | const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n); | |
136 | ||
137 | /* | |
138 | * Return the offset of the nth object within the specified packfile. | |
139 | * The index must already be opened. | |
140 | */ | |
141 | off_t nth_packed_object_offset(const struct packed_git *, uint32_t n); | |
142 | ||
143 | /* | |
144 | * If the object named sha1 is present in the specified packfile, | |
145 | * return its offset within the packfile; otherwise, return 0. | |
146 | */ | |
147 | off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *); | |
148 | ||
149 | int is_pack_valid(struct packed_git *); | |
150 | void *unpack_entry(struct repository *r, struct packed_git *, off_t, enum object_type *, unsigned long *); | |
151 | unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep); | |
152 | unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t); | |
153 | int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *); | |
154 | ||
155 | void release_pack_memory(size_t); | |
156 | ||
157 | /* global flag to enable extra checks when accessing packed objects */ | |
158 | extern int do_check_packed_object_crc; | |
159 | ||
160 | int packed_object_info(struct repository *r, | |
161 | struct packed_git *pack, | |
162 | off_t offset, struct object_info *); | |
163 | ||
164 | void mark_bad_packed_object(struct packed_git *p, const unsigned char *sha1); | |
165 | const struct packed_git *has_packed_and_bad(struct repository *r, const unsigned char *sha1); | |
166 | ||
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 | */ | |
171 | int find_pack_entry(struct repository *r, const struct object_id *oid, struct pack_entry *e); | |
172 | ||
173 | int has_object_pack(const struct object_id *oid); | |
174 | ||
175 | int has_pack_index(const unsigned char *sha1); | |
176 | ||
177 | /* | |
178 | * Return 1 if an object in a promisor packfile is or refers to the given | |
179 | * object, 0 otherwise. | |
180 | */ | |
181 | int is_promisor_object(const struct object_id *oid); | |
182 | ||
183 | /* | |
184 | * Expose a function for fuzz testing. | |
185 | * | |
186 | * load_idx() parses a block of memory as a packfile index and puts the results | |
187 | * into a struct packed_git. | |
188 | * | |
189 | * This function should not be used directly. It is exposed here only so that we | |
190 | * have a convenient entry-point for fuzz testing. For real uses, you should | |
191 | * probably use open_pack_index() or parse_pack_index() instead. | |
192 | */ | |
193 | int load_idx(const char *path, const unsigned int hashsz, void *idx_map, | |
194 | size_t idx_size, struct packed_git *p); | |
195 | ||
196 | #endif |