Andrew's git - gitweb.git/blob

   1#ifndef PACKFILE_H
   2#define PACKFILE_H
   3
   4/*
   5 * Generate the filename to be used for a pack file with checksum "sha1" and
   6 * extension "ext". The result is written into the strbuf "buf", overwriting
   7 * any existing contents. A pointer to buf->buf is returned as a convenience.
   8 *
   9 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"
  10 */
  11extern char *odb_pack_name(struct strbuf *buf, const unsigned char *sha1, const char *ext);
  12
  13/*
  14 * Return the name of the (local) packfile with the specified sha1 in
  15 * its name.  The return value is a pointer to memory that is
  16 * overwritten each time this function is called.
  17 */
  18extern char *sha1_pack_name(const unsigned char *sha1);
  19
  20/*
  21 * Return the name of the (local) pack index file with the specified
  22 * sha1 in 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_index_name(const unsigned char *sha1);
  26
  27extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
  28
  29/* A hook to report invalid files in pack directory */
  30#define PACKDIR_FILE_PACK 1
  31#define PACKDIR_FILE_IDX 2
  32#define PACKDIR_FILE_GARBAGE 4
  33extern void (*report_garbage)(unsigned seen_bits, const char *path);
  34
  35extern void prepare_packed_git(void);
  36extern void reprepare_packed_git(void);
  37extern void install_packed_git(struct packed_git *pack);
  38
  39/*
  40 * Give a rough count of objects in the repository. This sacrifices accuracy
  41 * for speed.
  42 */
  43unsigned long approximate_object_count(void);
  44
  45extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
  46                                         struct packed_git *packs);
  47
  48extern void pack_report(void);
  49
  50/*
  51 * mmap the index file for the specified packfile (if it is not
  52 * already mmapped).  Return 0 on success.
  53 */
  54extern int open_pack_index(struct packed_git *);
  55
  56/*
  57 * munmap the index file for the specified packfile (if it is
  58 * currently mmapped).
  59 */
  60extern void close_pack_index(struct packed_git *);
  61
  62extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
  63extern void close_pack_windows(struct packed_git *);
  64extern void close_all_packs(void);
  65extern void unuse_pack(struct pack_window **);
  66extern void clear_delta_base_cache(void);
  67extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
  68
  69/*
  70 * Make sure that a pointer access into an mmap'd index file is within bounds,
  71 * and can provide at least 8 bytes of data.
  72 *
  73 * Note that this is only necessary for variable-length segments of the file
  74 * (like the 64-bit extended offset table), as we compare the size to the
  75 * fixed-length parts when we open the file.
  76 */
  77extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
  78
  79/*
  80 * Return the SHA-1 of the nth object within the specified packfile.
  81 * Open the index if it is not already open.  The return value points
  82 * at the SHA-1 within the mmapped index.  Return NULL if there is an
  83 * error.
  84 */
  85extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
  86/*
  87 * Like nth_packed_object_sha1, but write the data into the object specified by
  88 * the the first argument.  Returns the first argument on success, and NULL on
  89 * error.
  90 */
  91extern const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n);
  92
  93/*
  94 * Return the offset of the nth object within the specified packfile.
  95 * The index must already be opened.
  96 */
  97extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
  98
  99/*
 100 * If the object named sha1 is present in the specified packfile,
 101 * return its offset within the packfile; otherwise, return 0.
 102 */
 103extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
 104
 105extern int is_pack_valid(struct packed_git *);
 106extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
 107extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
 108extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
 109extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
 110
 111extern void release_pack_memory(size_t);
 112
 113/* global flag to enable extra checks when accessing packed objects */
 114extern int do_check_packed_object_crc;
 115
 116extern int packed_object_info(struct packed_git *pack, off_t offset, struct object_info *);
 117
 118extern void mark_bad_packed_object(struct packed_git *p, const unsigned char *sha1);
 119extern const struct packed_git *has_packed_and_bad(const unsigned char *sha1);
 120
 121extern int find_pack_entry(const unsigned char *sha1, struct pack_entry *e);
 122
 123extern int has_sha1_pack(const unsigned char *sha1);
 124
 125extern int has_pack_index(const unsigned char *sha1);
 126
 127/*
 128 * Iterate over packed objects in both the local
 129 * repository and any alternates repositories (unless the
 130 * FOR_EACH_OBJECT_LOCAL_ONLY flag, defined in cache.h, is set).
 131 */
 132typedef int each_packed_object_fn(const struct object_id *oid,
 133                                  struct packed_git *pack,
 134                                  uint32_t pos,
 135                                  void *data);
 136extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
 137
 138#endif