Andrew's git - gitweb.git/blob

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