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 */ 18externchar*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 */ 25externchar*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 */ 32externchar*sha1_pack_index_name(const unsigned char*sha1); 33 34externstruct packed_git *parse_pack_index(unsigned char*sha1,const char*idx_path); 35 36typedefvoideach_file_in_pack_dir_fn(const char*full_path,size_t full_path_len, 37const char*file_pach,void*data); 38voidfor_each_file_in_pack_dir(const char*objdir, 39 each_file_in_pack_dir_fn fn, 40void*data); 41 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 46externvoid(*report_garbage)(unsigned seen_bits,const char*path); 47 48externvoidreprepare_packed_git(struct repository *r); 49externvoidinstall_packed_git(struct repository *r,struct packed_git *pack); 50 51struct packed_git *get_packed_git(struct repository *r); 52struct list_head *get_packed_git_mru(struct repository *r); 53struct multi_pack_index *get_multi_pack_index(struct repository *r); 54struct packed_git *get_all_packs(struct repository *r); 55 56/* 57 * Give a rough count of objects in the repository. This sacrifices accuracy 58 * for speed. 59 */ 60unsigned longapproximate_object_count(void); 61 62externstruct packed_git *find_sha1_pack(const unsigned char*sha1, 63struct packed_git *packs); 64 65externvoidpack_report(void); 66 67/* 68 * mmap the index file for the specified packfile (if it is not 69 * already mmapped). Return 0 on success. 70 */ 71externintopen_pack_index(struct packed_git *); 72 73/* 74 * munmap the index file for the specified packfile (if it is 75 * currently mmapped). 76 */ 77externvoidclose_pack_index(struct packed_git *); 78 79externuint32_tget_pack_fanout(struct packed_git *p,uint32_t value); 80 81externunsigned char*use_pack(struct packed_git *,struct pack_window **, off_t,unsigned long*); 82externvoidclose_pack_windows(struct packed_git *); 83externvoidclose_pack(struct packed_git *); 84externvoidclose_object_store(struct raw_object_store *o); 85externvoidunuse_pack(struct pack_window **); 86externvoidclear_delta_base_cache(void); 87externstruct packed_git *add_packed_git(const char*path,size_t path_len,int local); 88 89/* 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 */ 97externvoidcheck_pack_index_ptr(const struct packed_git *p,const void*ptr); 98 99/* 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 */ 105intbsearch_pack(const struct object_id *oid,const struct packed_git *p,uint32_t*result); 106 107/* 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 */ 113externconst 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 */ 119externconst struct object_id *nth_packed_object_oid(struct object_id *,struct packed_git *,uint32_t n); 120 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); 126 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 133externintis_pack_valid(struct packed_git *); 134externvoid*unpack_entry(struct repository *r,struct packed_git *, off_t,enum object_type *,unsigned long*); 135externunsigned longunpack_object_header_buffer(const unsigned char*buf,unsigned long len,enum object_type *type,unsigned long*sizep); 136externunsigned longget_size_from_delta(struct packed_git *,struct pack_window **, off_t); 137externintunpack_object_header(struct packed_git *,struct pack_window **, off_t *,unsigned long*); 138 139externvoidrelease_pack_memory(size_t); 140 141/* global flag to enable extra checks when accessing packed objects */ 142externint do_check_packed_object_crc; 143 144externintpacked_object_info(struct repository *r, 145struct packed_git *pack, 146 off_t offset,struct object_info *); 147 148externvoidmark_bad_packed_object(struct packed_git *p,const unsigned char*sha1); 149externconst struct packed_git *has_packed_and_bad(struct repository *r,const unsigned char*sha1); 150 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 */ 155externintfind_pack_entry(struct repository *r,const struct object_id *oid,struct pack_entry *e); 156 157externinthas_object_pack(const struct object_id *oid); 158 159externinthas_pack_index(const unsigned char*sha1); 160 161/* 162 * Return 1 if an object in a promisor packfile is or refers to the given 163 * object, 0 otherwise. 164 */ 165externintis_promisor_object(const struct object_id *oid); 166 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 */ 177externintload_idx(const char*path,const unsigned int hashsz,void*idx_map, 178size_t idx_size,struct packed_git *p); 179 180#endif