packfile.hon commit pack: move nth_packed_object_{sha1,oid} (d5a1676)
   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 void pack_report(void);
  46
  47/*
  48 * mmap the index file for the specified packfile (if it is not
  49 * already mmapped).  Return 0 on success.
  50 */
  51extern int open_pack_index(struct packed_git *);
  52
  53/*
  54 * munmap the index file for the specified packfile (if it is
  55 * currently mmapped).
  56 */
  57extern void close_pack_index(struct packed_git *);
  58
  59extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
  60extern void close_pack_windows(struct packed_git *);
  61extern void close_all_packs(void);
  62extern void unuse_pack(struct pack_window **);
  63extern void clear_delta_base_cache(void);
  64extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
  65
  66/*
  67 * Return the SHA-1 of the nth object within the specified packfile.
  68 * Open the index if it is not already open.  The return value points
  69 * at the SHA-1 within the mmapped index.  Return NULL if there is an
  70 * error.
  71 */
  72extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
  73/*
  74 * Like nth_packed_object_sha1, but write the data into the object specified by
  75 * the the first argument.  Returns the first argument on success, and NULL on
  76 * error.
  77 */
  78extern const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n);
  79
  80
  81extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
  82extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
  83extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
  84extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
  85
  86extern void release_pack_memory(size_t);
  87
  88extern int open_packed_git(struct packed_git *p);
  89
  90/* global flag to enable extra checks when accessing packed objects */
  91extern int do_check_packed_object_crc;
  92
  93extern int packed_object_info(struct packed_git *pack, off_t offset, struct object_info *);
  94
  95extern void mark_bad_packed_object(struct packed_git *p, const unsigned char *sha1);
  96extern const struct packed_git *has_packed_and_bad(const unsigned char *sha1);
  97#endif