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