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