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