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