1#ifndef PACKFILE_H 2#define PACKFILE_H 3 4#include"oidset.h" 5 6/* 7 * Generate the filename to be used for a pack file with checksum "sha1" and 8 * extension "ext". The result is written into the strbuf "buf", overwriting 9 * any existing contents. A pointer to buf->buf is returned as a convenience. 10 * 11 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx" 12 */ 13externchar*odb_pack_name(struct strbuf *buf,const unsigned char*sha1,const char*ext); 14 15/* 16 * Return the name of the (local) packfile with the specified sha1 in 17 * its name. The return value is a pointer to memory that is 18 * overwritten each time this function is called. 19 */ 20externchar*sha1_pack_name(const unsigned char*sha1); 21 22/* 23 * Return the name of the (local) pack index file with the specified 24 * sha1 in its name. The return value is a pointer to memory that is 25 * overwritten each time this function is called. 26 */ 27externchar*sha1_pack_index_name(const unsigned char*sha1); 28 29externstruct packed_git *parse_pack_index(unsigned char*sha1,const char*idx_path); 30 31/* A hook to report invalid files in pack directory */ 32#define PACKDIR_FILE_PACK 1 33#define PACKDIR_FILE_IDX 2 34#define PACKDIR_FILE_GARBAGE 4 35externvoid(*report_garbage)(unsigned seen_bits,const char*path); 36 37externvoidreprepare_packed_git(struct repository *r); 38externvoidinstall_packed_git(struct repository *r,struct packed_git *pack); 39 40struct packed_git *get_packed_git(struct repository *r); 41struct list_head *get_packed_git_mru(struct repository *r); 42 43/* 44 * Give a rough count of objects in the repository. This sacrifices accuracy 45 * for speed. 46 */ 47unsigned longapproximate_object_count(void); 48 49externstruct packed_git *find_sha1_pack(const unsigned char*sha1, 50struct packed_git *packs); 51 52externvoidpack_report(void); 53 54/* 55 * mmap the index file for the specified packfile (if it is not 56 * already mmapped). Return 0 on success. 57 */ 58externintopen_pack_index(struct packed_git *); 59 60/* 61 * munmap the index file for the specified packfile (if it is 62 * currently mmapped). 63 */ 64externvoidclose_pack_index(struct packed_git *); 65 66externunsigned char*use_pack(struct packed_git *,struct pack_window **, off_t,unsigned long*); 67externvoidclose_pack_windows(struct packed_git *); 68externvoidclose_all_packs(struct raw_object_store *o); 69externvoidunuse_pack(struct pack_window **); 70externvoidclear_delta_base_cache(void); 71externstruct packed_git *add_packed_git(const char*path,size_t path_len,int local); 72 73/* 74 * Make sure that a pointer access into an mmap'd index file is within bounds, 75 * and can provide at least 8 bytes of data. 76 * 77 * Note that this is only necessary for variable-length segments of the file 78 * (like the 64-bit extended offset table), as we compare the size to the 79 * fixed-length parts when we open the file. 80 */ 81externvoidcheck_pack_index_ptr(const struct packed_git *p,const void*ptr); 82 83/* 84 * Return the SHA-1 of the nth object within the specified packfile. 85 * Open the index if it is not already open. The return value points 86 * at the SHA-1 within the mmapped index. Return NULL if there is an 87 * error. 88 */ 89externconst unsigned char*nth_packed_object_sha1(struct packed_git *,uint32_t n); 90/* 91 * Like nth_packed_object_sha1, but write the data into the object specified by 92 * the the first argument. Returns the first argument on success, and NULL on 93 * error. 94 */ 95externconst struct object_id *nth_packed_object_oid(struct object_id *,struct packed_git *,uint32_t n); 96 97/* 98 * Return the offset of the nth object within the specified packfile. 99 * The index must already be opened. 100 */ 101extern off_t nth_packed_object_offset(const struct packed_git *,uint32_t n); 102 103/* 104 * If the object named sha1 is present in the specified packfile, 105 * return its offset within the packfile; otherwise, return 0. 106 */ 107extern off_t find_pack_entry_one(const unsigned char*sha1,struct packed_git *); 108 109externintis_pack_valid(struct packed_git *); 110externvoid*unpack_entry(struct packed_git *, off_t,enum object_type *,unsigned long*); 111externunsigned longunpack_object_header_buffer(const unsigned char*buf,unsigned long len,enum object_type *type,unsigned long*sizep); 112externunsigned longget_size_from_delta(struct packed_git *,struct pack_window **, off_t); 113externintunpack_object_header(struct packed_git *,struct pack_window **, off_t *,unsigned long*); 114 115externvoidrelease_pack_memory(size_t); 116 117/* global flag to enable extra checks when accessing packed objects */ 118externint do_check_packed_object_crc; 119 120externintpacked_object_info(struct packed_git *pack, off_t offset,struct object_info *); 121 122externvoidmark_bad_packed_object(struct packed_git *p,const unsigned char*sha1); 123externconst struct packed_git *has_packed_and_bad(const unsigned char*sha1); 124 125/* 126 * Iff a pack file in the given repository contains the object named by sha1, 127 * return true and store its location to e. 128 */ 129externintfind_pack_entry(struct repository *r,const unsigned char*sha1,struct pack_entry *e); 130 131externinthas_sha1_pack(const unsigned char*sha1); 132 133externinthas_pack_index(const unsigned char*sha1); 134 135/* 136 * Only iterate over packs obtained from the promisor remote. 137 */ 138#define FOR_EACH_OBJECT_PROMISOR_ONLY 2 139 140/* 141 * Iterate over packed objects in both the local 142 * repository and any alternates repositories (unless the 143 * FOR_EACH_OBJECT_LOCAL_ONLY flag, defined in cache.h, is set). 144 */ 145typedefinteach_packed_object_fn(const struct object_id *oid, 146struct packed_git *pack, 147uint32_t pos, 148void*data); 149externintfor_each_packed_object(each_packed_object_fn,void*,unsigned flags); 150 151/* 152 * Return 1 if an object in a promisor packfile is or refers to the given 153 * object, 0 otherwise. 154 */ 155externintis_promisor_object(const struct object_id *oid); 156 157#endif