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 37#define prepare_packed_git(r) prepare_packed_git_##r() 38externvoidprepare_packed_git_the_repository(void); 39#define reprepare_packed_git(r) reprepare_packed_git_##r() 40externvoidreprepare_packed_git_the_repository(void); 41externvoidinstall_packed_git(struct repository *r,struct packed_git *pack); 42 43struct packed_git *get_packed_git(struct repository *r); 44struct list_head *get_packed_git_mru(struct repository *r); 45 46/* 47 * Give a rough count of objects in the repository. This sacrifices accuracy 48 * for speed. 49 */ 50unsigned longapproximate_object_count(void); 51 52externstruct packed_git *find_sha1_pack(const unsigned char*sha1, 53struct packed_git *packs); 54 55externvoidpack_report(void); 56 57/* 58 * mmap the index file for the specified packfile (if it is not 59 * already mmapped). Return 0 on success. 60 */ 61externintopen_pack_index(struct packed_git *); 62 63/* 64 * munmap the index file for the specified packfile (if it is 65 * currently mmapped). 66 */ 67externvoidclose_pack_index(struct packed_git *); 68 69externunsigned char*use_pack(struct packed_git *,struct pack_window **, off_t,unsigned long*); 70externvoidclose_pack_windows(struct packed_git *); 71externvoidclose_all_packs(struct raw_object_store *o); 72externvoidunuse_pack(struct pack_window **); 73externvoidclear_delta_base_cache(void); 74externstruct packed_git *add_packed_git(const char*path,size_t path_len,int local); 75 76/* 77 * Make sure that a pointer access into an mmap'd index file is within bounds, 78 * and can provide at least 8 bytes of data. 79 * 80 * Note that this is only necessary for variable-length segments of the file 81 * (like the 64-bit extended offset table), as we compare the size to the 82 * fixed-length parts when we open the file. 83 */ 84externvoidcheck_pack_index_ptr(const struct packed_git *p,const void*ptr); 85 86/* 87 * Return the SHA-1 of the nth object within the specified packfile. 88 * Open the index if it is not already open. The return value points 89 * at the SHA-1 within the mmapped index. Return NULL if there is an 90 * error. 91 */ 92externconst unsigned char*nth_packed_object_sha1(struct packed_git *,uint32_t n); 93/* 94 * Like nth_packed_object_sha1, but write the data into the object specified by 95 * the the first argument. Returns the first argument on success, and NULL on 96 * error. 97 */ 98externconst struct object_id *nth_packed_object_oid(struct object_id *,struct packed_git *,uint32_t n); 99 100/* 101 * Return the offset of the nth object within the specified packfile. 102 * The index must already be opened. 103 */ 104extern off_t nth_packed_object_offset(const struct packed_git *,uint32_t n); 105 106/* 107 * If the object named sha1 is present in the specified packfile, 108 * return its offset within the packfile; otherwise, return 0. 109 */ 110extern off_t find_pack_entry_one(const unsigned char*sha1,struct packed_git *); 111 112externintis_pack_valid(struct packed_git *); 113externvoid*unpack_entry(struct packed_git *, off_t,enum object_type *,unsigned long*); 114externunsigned longunpack_object_header_buffer(const unsigned char*buf,unsigned long len,enum object_type *type,unsigned long*sizep); 115externunsigned longget_size_from_delta(struct packed_git *,struct pack_window **, off_t); 116externintunpack_object_header(struct packed_git *,struct pack_window **, off_t *,unsigned long*); 117 118externvoidrelease_pack_memory(size_t); 119 120/* global flag to enable extra checks when accessing packed objects */ 121externint do_check_packed_object_crc; 122 123externintpacked_object_info(struct packed_git *pack, off_t offset,struct object_info *); 124 125externvoidmark_bad_packed_object(struct packed_git *p,const unsigned char*sha1); 126externconst struct packed_git *has_packed_and_bad(const unsigned char*sha1); 127 128externintfind_pack_entry(const unsigned char*sha1,struct pack_entry *e); 129 130externinthas_sha1_pack(const unsigned char*sha1); 131 132externinthas_pack_index(const unsigned char*sha1); 133 134/* 135 * Only iterate over packs obtained from the promisor remote. 136 */ 137#define FOR_EACH_OBJECT_PROMISOR_ONLY 2 138 139/* 140 * Iterate over packed objects in both the local 141 * repository and any alternates repositories (unless the 142 * FOR_EACH_OBJECT_LOCAL_ONLY flag, defined in cache.h, is set). 143 */ 144typedefinteach_packed_object_fn(const struct object_id *oid, 145struct packed_git *pack, 146uint32_t pos, 147void*data); 148externintfor_each_packed_object(each_packed_object_fn,void*,unsigned flags); 149 150/* 151 * Return 1 if an object in a promisor packfile is or refers to the given 152 * object, 0 otherwise. 153 */ 154externintis_promisor_object(const struct object_id *oid); 155 156#endif