Andrew's git / gitweb.git /
e0a38aba9321deae1d64aea7cd87067fde240b10
   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 reprepare_packed_git(struct repository *r);
  38extern void install_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 long approximate_object_count(void);
  48
  49extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
  50                                         struct packed_git *packs);
  51
  52extern void pack_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 */
  58extern int open_pack_index(struct packed_git *);
  59
  60/*
  61 * munmap the index file for the specified packfile (if it is
  62 * currently mmapped).
  63 */
  64extern void close_pack_index(struct packed_git *);
  65
  66extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
  67extern void close_pack_windows(struct packed_git *);
  68extern void close_pack(struct packed_git *);
  69extern void close_all_packs(struct raw_object_store *o);
  70extern void unuse_pack(struct pack_window **);
  71extern void clear_delta_base_cache(void);
  72extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
  73
  74/*
  75 * Make sure that a pointer access into an mmap'd index file is within bounds,
  76 * and can provide at least 8 bytes of data.
  77 *
  78 * Note that this is only necessary for variable-length segments of the file
  79 * (like the 64-bit extended offset table), as we compare the size to the
  80 * fixed-length parts when we open the file.
  81 */
  82extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
  83
  84/*
  85 * Perform binary search on a pack-index for a given oid. Packfile is expected to
  86 * have a valid pack-index.
  87 *
  88 * See 'bsearch_hash' for more information.
  89 */
  90int bsearch_pack(const struct object_id *oid, const struct packed_git *p, uint32_t *result);
  91
  92/*
  93 * Return the SHA-1 of the nth object within the specified packfile.
  94 * Open the index if it is not already open.  The return value points
  95 * at the SHA-1 within the mmapped index.  Return NULL if there is an
  96 * error.
  97 */
  98extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
  99/*
 100 * Like nth_packed_object_sha1, but write the data into the object specified by
 101 * the the first argument.  Returns the first argument on success, and NULL on
 102 * error.
 103 */
 104extern const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n);
 105
 106/*
 107 * Return the offset of the nth object within the specified packfile.
 108 * The index must already be opened.
 109 */
 110extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
 111
 112/*
 113 * If the object named sha1 is present in the specified packfile,
 114 * return its offset within the packfile; otherwise, return 0.
 115 */
 116extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
 117
 118extern int is_pack_valid(struct packed_git *);
 119extern void *unpack_entry(struct repository *r, struct packed_git *, off_t, enum object_type *, unsigned long *);
 120extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
 121extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
 122extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
 123
 124extern void release_pack_memory(size_t);
 125
 126/* global flag to enable extra checks when accessing packed objects */
 127extern int do_check_packed_object_crc;
 128
 129extern int packed_object_info(struct repository *r,
 130                              struct packed_git *pack,
 131                              off_t offset, struct object_info *);
 132
 133extern void mark_bad_packed_object(struct packed_git *p, const unsigned char *sha1);
 134extern const struct packed_git *has_packed_and_bad(const unsigned char *sha1);
 135
 136/*
 137 * Iff a pack file in the given repository contains the object named by sha1,
 138 * return true and store its location to e.
 139 */
 140extern int find_pack_entry(struct repository *r, const struct object_id *oid, struct pack_entry *e);
 141
 142extern int has_object_pack(const struct object_id *oid);
 143
 144extern int has_pack_index(const unsigned char *sha1);
 145
 146/*
 147 * Only iterate over packs obtained from the promisor remote.
 148 */
 149#define FOR_EACH_OBJECT_PROMISOR_ONLY 2
 150
 151/*
 152 * Iterate over packed objects in both the local
 153 * repository and any alternates repositories (unless the
 154 * FOR_EACH_OBJECT_LOCAL_ONLY flag, defined in cache.h, is set).
 155 */
 156typedef int each_packed_object_fn(const struct object_id *oid,
 157                                  struct packed_git *pack,
 158                                  uint32_t pos,
 159                                  void *data);
 160extern int for_each_object_in_pack(struct packed_git *p, each_packed_object_fn, void *data);
 161extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
 162
 163/*
 164 * Return 1 if an object in a promisor packfile is or refers to the given
 165 * object, 0 otherwise.
 166 */
 167extern int is_promisor_object(const struct object_id *oid);
 168
 169#endif