🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.20.4 / . / packfile.h
blob: 6c4037605d0dfee59a084c440506f1af11708d63 [file] [log] [blame]
Jonathan Tan4f39cd82017-08-18 22:20:16[diff] [blame]1#ifndef PACKFILE_H
2#define PACKFILE_H
3
Beat Bollib42f98a2018-07-25 21:56:07[diff] [blame]4#include "cache.h"
Jonathan Tan498f1f62017-12-05 16:58:44[diff] [blame]5#include "oidset.h"
6
Stefan Bellercbd53a22018-05-15 23:42:15[diff] [blame]7/* in object-store.h */
8struct packed_git;
9struct object_info;
Stefan Bellercbd53a22018-05-15 23:42:15[diff] [blame]10
Jonathan Tan4f39cd82017-08-18 22:20:16[diff] [blame]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 */
18extern 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 */
25extern 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 */
32extern char *sha1_pack_index_name(const unsigned char *sha1);
33
Jonathan Tan0317f452017-08-18 22:20:19[diff] [blame]34extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
35
Derrick Stolee9208e312018-07-12 19:39:25[diff] [blame]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
Jonathan Tan0abe14f2017-08-18 22:20:26[diff] [blame]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
Stefan Beller4c2a13b2018-03-23 17:45:24[diff] [blame]48extern void reprepare_packed_git(struct repository *r);
Stefan Beller5babff12018-03-23 17:45:18[diff] [blame]49extern void install_packed_git(struct repository *r, struct packed_git *pack);
Jonathan Tane65f1862017-08-18 22:20:25[diff] [blame]50
Stefan Bellera80d72d2018-03-23 17:20:59[diff] [blame]51struct packed_git *get_packed_git(struct repository *r);
52struct list_head *get_packed_git_mru(struct repository *r);
Derrick Stolee8aac67a2018-07-12 19:39:35[diff] [blame]53struct multi_pack_index *get_multi_pack_index(struct repository *r);
Derrick Stolee0bff5262018-08-20 16:52:02[diff] [blame]54struct packed_git *get_all_packs(struct repository *r);
Stefan Bellera80d72d2018-03-23 17:20:59[diff] [blame]55
Jonathan Tan0abe14f2017-08-18 22:20:26[diff] [blame]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
Jonathan Tand6fe0032017-08-18 22:20:34[diff] [blame]62extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
63 struct packed_git *packs);
64
Jonathan Tan8e211762017-08-18 22:20:18[diff] [blame]65extern void pack_report(void);
66
Jonathan Tan0317f452017-08-18 22:20:19[diff] [blame]67/*
68 * mmap the index file for the specified packfile (if it is not
69 * already mmapped). Return 0 on success.
70 */
71extern int open_pack_index(struct packed_git *);
72
Jonathan Tan3836d882017-08-18 22:20:21[diff] [blame]73/*
74 * munmap the index file for the specified packfile (if it is
75 * currently mmapped).
76 */
77extern void close_pack_index(struct packed_git *);
78
Derrick Stoleefe1ed562018-07-12 19:39:29[diff] [blame]79extern uint32_t get_pack_fanout(struct packed_git *p, uint32_t value);
80
Jonathan Tan84f80ad2017-08-18 22:20:22[diff] [blame]81extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
Jonathan Tan3836d882017-08-18 22:20:21[diff] [blame]82extern void close_pack_windows(struct packed_git *);
Derrick Stolee049d51a2018-04-10 12:56:06[diff] [blame]83extern void close_pack(struct packed_git *);
Stefan Bellerd0b59862018-03-23 17:21:00[diff] [blame]84extern void close_all_packs(struct raw_object_store *o);
Jonathan Tan97de1802017-08-18 22:20:23[diff] [blame]85extern void unuse_pack(struct pack_window **);
Jonathan Tanf1d81302017-08-18 22:20:30[diff] [blame]86extern void clear_delta_base_cache(void);
Jonathan Tan9a428652017-08-18 22:20:24[diff] [blame]87extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
Jonathan Tan3836d882017-08-18 22:20:21[diff] [blame]88
Jonathan Tand5a16762017-08-18 22:20:31[diff] [blame]89/*
Jonathan Tan9e0f45f2017-08-18 22:20:32[diff] [blame]90 * Make sure that a pointer access into an mmap'd index file is within bounds,
91 * and can provide at least 8 bytes of data.
92 *
93 * Note that this is only necessary for variable-length segments of the file
94 * (like the 64-bit extended offset table), as we compare the size to the
95 * fixed-length parts when we open the file.
96 */
97extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
98
99/*
Derrick Stolee3d475f42018-03-22 17:40:09[diff] [blame]100 * Perform binary search on a pack-index for a given oid. Packfile is expected to
101 * have a valid pack-index.
102 *
103 * See 'bsearch_hash' for more information.
104 */
105int bsearch_pack(const struct object_id *oid, const struct packed_git *p, uint32_t *result);
106
107/*
Jonathan Tand5a16762017-08-18 22:20:31[diff] [blame]108 * Return the SHA-1 of the nth object within the specified packfile.
109 * Open the index if it is not already open. The return value points
110 * at the SHA-1 within the mmapped index. Return NULL if there is an
111 * error.
112 */
113extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
114/*
115 * Like nth_packed_object_sha1, but write the data into the object specified by
116 * the the first argument. Returns the first argument on success, and NULL on
117 * error.
118 */
119extern const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n);
120
Jonathan Tan9e0f45f2017-08-18 22:20:32[diff] [blame]121/*
122 * Return the offset of the nth object within the specified packfile.
123 * The index must already be opened.
124 */
125extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
Jonathan Tand5a16762017-08-18 22:20:31[diff] [blame]126
Jonathan Tana2551952017-08-18 22:20:33[diff] [blame]127/*
128 * If the object named sha1 is present in the specified packfile,
129 * return its offset within the packfile; otherwise, return 0.
130 */
131extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
132
133extern int is_pack_valid(struct packed_git *);
Stefan Beller9d983542018-04-25 18:21:06[diff] [blame]134extern void *unpack_entry(struct repository *r, struct packed_git *, off_t, enum object_type *, unsigned long *);
Jonathan Tan32b42e12017-08-18 22:20:27[diff] [blame]135extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
Jonathan Tan7b3aa752017-08-18 22:20:28[diff] [blame]136extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
Jonathan Tan3588dd62017-08-18 22:20:29[diff] [blame]137extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
Jonathan Tan32b42e12017-08-18 22:20:27[diff] [blame]138
Jonathan Tanf0e17e82017-08-18 22:20:20[diff] [blame]139extern void release_pack_memory(size_t);
140
Jonathan Tanf1d81302017-08-18 22:20:30[diff] [blame]141/* global flag to enable extra checks when accessing packed objects */
142extern int do_check_packed_object_crc;
143
Stefan Beller9d983542018-04-25 18:21:06[diff] [blame]144extern int packed_object_info(struct repository *r,
145 struct packed_git *pack,
146 off_t offset, struct object_info *);
Jonathan Tanf1d81302017-08-18 22:20:30[diff] [blame]147
148extern void mark_bad_packed_object(struct packed_git *p, const unsigned char *sha1);
149extern const struct packed_git *has_packed_and_bad(const unsigned char *sha1);
Jonathan Tan9e0f45f2017-08-18 22:20:32[diff] [blame]150
Stefan Beller613b42f22018-03-23 17:45:25[diff] [blame]151/*
152 * Iff a pack file in the given repository contains the object named by sha1,
153 * return true and store its location to e.
154 */
brian m. carlson544443c2018-05-02 00:25:35[diff] [blame]155extern int find_pack_entry(struct repository *r, const struct object_id *oid, struct pack_entry *e);
Jonathan Tan1a1e5d42017-08-18 22:20:35[diff] [blame]156
brian m. carlson14c3c802018-05-02 00:25:33[diff] [blame]157extern int has_object_pack(const struct object_id *oid);
Jonathan Tan150e3002017-08-18 22:20:36[diff] [blame]158
Jonathan Tanf9a86722017-08-18 22:20:37[diff] [blame]159extern int has_pack_index(const unsigned char *sha1);
160
Jonathan Tan7709f462017-08-18 22:20:38[diff] [blame]161/*
Jonathan Tan498f1f62017-12-05 16:58:44[diff] [blame]162 * Return 1 if an object in a promisor packfile is or refers to the given
163 * object, 0 otherwise.
164 */
165extern int is_promisor_object(const struct object_id *oid);
166
Josh Steadmon1127a982018-10-13 00:58:41[diff] [blame]167/*
168 * Expose a function for fuzz testing.
169 *
170 * load_idx() parses a block of memory as a packfile index and puts the results
171 * into a struct packed_git.
172 *
173 * This function should not be used directly. It is exposed here only so that we
174 * have a convenient entry-point for fuzz testing. For real uses, you should
175 * probably use open_pack_index() or parse_pack_index() instead.
176 */
177extern int load_idx(const char *path, const unsigned int hashsz, void *idx_map,
178 size_t idx_size, struct packed_git *p);
179
Jonathan Tan4f39cd82017-08-18 22:20:16[diff] [blame]180#endif