1#ifndef PACKFILE_H 2#define PACKFILE_H 3 4#include"cache.h" 5#include"oidset.h" 6 7/* in object-store.h */ 8struct packed_git; 9struct 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 */ 18char*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 */ 25char*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 */ 32char*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 */ 38const char*pack_basename(struct packed_git *p); 39 40struct packed_git *parse_pack_index(unsigned char*sha1,const char*idx_path); 41 42typedefvoideach_file_in_pack_dir_fn(const char*full_path,size_t full_path_len, 43const char*file_pach,void*data); 44voidfor_each_file_in_pack_dir(const char*objdir, 45 each_file_in_pack_dir_fn fn, 46void*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 52externvoid(*report_garbage)(unsigned seen_bits,const char*path); 53 54voidreprepare_packed_git(struct repository *r); 55voidinstall_packed_git(struct repository *r,struct packed_git *pack); 56 57struct packed_git *get_packed_git(struct repository *r); 58struct list_head *get_packed_git_mru(struct repository *r); 59struct multi_pack_index *get_multi_pack_index(struct repository *r); 60struct packed_git *get_all_packs(struct repository *r); 61 62/* 63 * Give a rough count of objects in the repository. This sacrifices accuracy 64 * for speed. 65 */ 66unsigned longrepo_approximate_object_count(struct repository *r); 67#define approximate_object_count() repo_approximate_object_count(the_repository) 68 69struct packed_git *find_sha1_pack(const unsigned char*sha1, 70struct packed_git *packs); 71 72voidpack_report(void); 73 74/* 75 * mmap the index file for the specified packfile (if it is not 76 * already mmapped). Return 0 on success. 77 */ 78intopen_pack_index(struct packed_git *); 79 80/* 81 * munmap the index file for the specified packfile (if it is 82 * currently mmapped). 83 */ 84voidclose_pack_index(struct packed_git *); 85 86intclose_pack_fd(struct packed_git *p); 87 88uint32_tget_pack_fanout(struct packed_git *p,uint32_t value); 89 90unsigned char*use_pack(struct packed_git *,struct pack_window **, off_t,unsigned long*); 91voidclose_pack_windows(struct packed_git *); 92voidclose_pack(struct packed_git *); 93voidclose_object_store(struct raw_object_store *o); 94voidunuse_pack(struct pack_window **); 95voidclear_delta_base_cache(void); 96struct packed_git *add_packed_git(const char*path,size_t path_len,int local); 97 98/* 99 * Make sure that a pointer access into an mmap'd index file is within bounds, 100 * and can provide at least 8 bytes of data. 101 * 102 * Note that this is only necessary for variable-length segments of the file 103 * (like the 64-bit extended offset table), as we compare the size to the 104 * fixed-length parts when we open the file. 105 */ 106voidcheck_pack_index_ptr(const struct packed_git *p,const void*ptr); 107 108/* 109 * Perform binary search on a pack-index for a given oid. Packfile is expected to 110 * have a valid pack-index. 111 * 112 * See 'bsearch_hash' for more information. 113 */ 114intbsearch_pack(const struct object_id *oid,const struct packed_git *p,uint32_t*result); 115 116/* 117 * Return the SHA-1 of the nth object within the specified packfile. 118 * Open the index if it is not already open. The return value points 119 * at the SHA-1 within the mmapped index. Return NULL if there is an 120 * error. 121 */ 122const unsigned char*nth_packed_object_sha1(struct packed_git *,uint32_t n); 123/* 124 * Like nth_packed_object_sha1, but write the data into the object specified by 125 * the the first argument. Returns the first argument on success, and NULL on 126 * error. 127 */ 128const struct object_id *nth_packed_object_oid(struct object_id *,struct packed_git *,uint32_t n); 129 130/* 131 * Return the offset of the nth object within the specified packfile. 132 * The index must already be opened. 133 */ 134off_t nth_packed_object_offset(const struct packed_git *,uint32_t n); 135 136/* 137 * If the object named sha1 is present in the specified packfile, 138 * return its offset within the packfile; otherwise, return 0. 139 */ 140off_t find_pack_entry_one(const unsigned char*sha1,struct packed_git *); 141 142intis_pack_valid(struct packed_git *); 143void*unpack_entry(struct repository *r,struct packed_git *, off_t,enum object_type *,unsigned long*); 144unsigned longunpack_object_header_buffer(const unsigned char*buf,unsigned long len,enum object_type *type,unsigned long*sizep); 145unsigned longget_size_from_delta(struct packed_git *,struct pack_window **, off_t); 146intunpack_object_header(struct packed_git *,struct pack_window **, off_t *,unsigned long*); 147 148voidrelease_pack_memory(size_t); 149 150/* global flag to enable extra checks when accessing packed objects */ 151externint do_check_packed_object_crc; 152 153intpacked_object_info(struct repository *r, 154struct packed_git *pack, 155 off_t offset,struct object_info *); 156 157voidmark_bad_packed_object(struct packed_git *p,const unsigned char*sha1); 158const struct packed_git *has_packed_and_bad(struct repository *r,const unsigned char*sha1); 159 160/* 161 * Iff a pack file in the given repository contains the object named by sha1, 162 * return true and store its location to e. 163 */ 164intfind_pack_entry(struct repository *r,const struct object_id *oid,struct pack_entry *e); 165 166inthas_object_pack(const struct object_id *oid); 167 168inthas_pack_index(const unsigned char*sha1); 169 170/* 171 * Return 1 if an object in a promisor packfile is or refers to the given 172 * object, 0 otherwise. 173 */ 174intis_promisor_object(const struct object_id *oid); 175 176/* 177 * Expose a function for fuzz testing. 178 * 179 * load_idx() parses a block of memory as a packfile index and puts the results 180 * into a struct packed_git. 181 * 182 * This function should not be used directly. It is exposed here only so that we 183 * have a convenient entry-point for fuzz testing. For real uses, you should 184 * probably use open_pack_index() or parse_pack_index() instead. 185 */ 186intload_idx(const char*path,const unsigned int hashsz,void*idx_map, 187size_t idx_size,struct packed_git *p); 188 189#endif