debian: new upstream release
[git/debian.git] / packfile.h
blob240aa73b95a64912fb2cde5be049f57d91e53b84
1 #ifndef PACKFILE_H
2 #define PACKFILE_H
4 #include "cache.h"
5 #include "oidset.h"
7 /* in object-store.h */
8 struct packed_git;
9 struct object_info;
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.
16 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"
18 char *odb_pack_name(struct strbuf *buf, const unsigned char *sha1, const char *ext);
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.
25 char *sha1_pack_name(const unsigned char *sha1);
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.
32 char *sha1_pack_index_name(const unsigned char *sha1);
35 * Return the basename of the packfile, omitting any containing directory
36 * (e.g., "pack-1234abcd[...].pack").
38 const char *pack_basename(struct packed_git *p);
40 struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
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);
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);
54 void reprepare_packed_git(struct repository *r);
55 void install_packed_git(struct repository *r, struct packed_git *pack);
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);
63 * Give a rough count of objects in the repository. This sacrifices accuracy
64 * for speed.
66 unsigned long repo_approximate_object_count(struct repository *r);
67 #define approximate_object_count() repo_approximate_object_count(the_repository)
69 struct packed_git *find_sha1_pack(const unsigned char *sha1,
70 struct packed_git *packs);
72 void pack_report(void);
75 * mmap the index file for the specified packfile (if it is not
76 * already mmapped). Return 0 on success.
78 int open_pack_index(struct packed_git *);
81 * munmap the index file for the specified packfile (if it is
82 * currently mmapped).
84 void close_pack_index(struct packed_git *);
86 int close_pack_fd(struct packed_git *p);
88 uint32_t get_pack_fanout(struct packed_git *p, uint32_t value);
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);
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".
103 void unlink_pack_path(const char *pack_name, int force_delete);
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.
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.
113 void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
116 * Perform binary search on a pack-index for a given oid. Packfile is expected to
117 * have a valid pack-index.
119 * See 'bsearch_hash' for more information.
121 int bsearch_pack(const struct object_id *oid, const struct packed_git *p, uint32_t *result);
124 * Write the oid of the nth object within the specified packfile into the first
125 * parameter. Open the index if it is not already open. Returns 0 on success,
126 * negative otherwise.
128 int nth_packed_object_id(struct object_id *, struct packed_git *, uint32_t n);
131 * Return the offset of the nth object within the specified packfile.
132 * The index must already be opened.
134 off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
137 * If the object named sha1 is present in the specified packfile,
138 * return its offset within the packfile; otherwise, return 0.
140 off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
142 int is_pack_valid(struct packed_git *);
143 void *unpack_entry(struct repository *r, struct packed_git *, off_t, enum object_type *, unsigned long *);
144 unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
145 unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
146 int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
147 off_t get_delta_base(struct packed_git *p, struct pack_window **w_curs,
148 off_t *curpos, enum object_type type,
149 off_t delta_obj_offset);
151 void release_pack_memory(size_t);
153 /* global flag to enable extra checks when accessing packed objects */
154 extern int do_check_packed_object_crc;
156 int packed_object_info(struct repository *r,
157 struct packed_git *pack,
158 off_t offset, struct object_info *);
160 void mark_bad_packed_object(struct packed_git *p, const unsigned char *sha1);
161 const struct packed_git *has_packed_and_bad(struct repository *r, const unsigned char *sha1);
164 * Iff a pack file in the given repository contains the object named by sha1,
165 * return true and store its location to e.
167 int find_pack_entry(struct repository *r, const struct object_id *oid, struct pack_entry *e);
169 int has_object_pack(const struct object_id *oid);
171 int has_pack_index(const unsigned char *sha1);
174 * Return 1 if an object in a promisor packfile is or refers to the given
175 * object, 0 otherwise.
177 int is_promisor_object(const struct object_id *oid);
180 * Expose a function for fuzz testing.
182 * load_idx() parses a block of memory as a packfile index and puts the results
183 * into a struct packed_git.
185 * This function should not be used directly. It is exposed here only so that we
186 * have a convenient entry-point for fuzz testing. For real uses, you should
187 * probably use open_pack_index() or parse_pack_index() instead.
189 int load_idx(const char *path, const unsigned int hashsz, void *idx_map,
190 size_t idx_size, struct packed_git *p);
192 #endif