THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

Git Source Code Mirror - This is a publish-only repository and all pull requests are ignored. Please follow Documentation/SubmittingPatches procedure for any of your improvements.
git
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

197 lines
6.9KB

  1. #ifndef PACKFILE_H
  2. #define PACKFILE_H
  3. #include "cache.h"
  4. #include "oidset.h"
  5. /* in object-store.h */
  6. struct packed_git;
  7. struct object_info;
  8. /*
  9. * Generate the filename to be used for a pack file with checksum "sha1" and
  10. * extension "ext". The result is written into the strbuf "buf", overwriting
  11. * any existing contents. A pointer to buf->buf is returned as a convenience.
  12. *
  13. * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"
  14. */
  15. char *odb_pack_name(struct strbuf *buf, const unsigned char *sha1, const char *ext);
  16. /*
  17. * Return the name of the (local) packfile with the specified sha1 in
  18. * its name. The return value is a pointer to memory that is
  19. * overwritten each time this function is called.
  20. */
  21. char *sha1_pack_name(const unsigned char *sha1);
  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. */
  27. char *sha1_pack_index_name(const unsigned char *sha1);
  28. /*
  29. * Return the basename of the packfile, omitting any containing directory
  30. * (e.g., "pack-1234abcd[...].pack").
  31. */
  32. const char *pack_basename(struct packed_git *p);
  33. struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
  34. typedef void each_file_in_pack_dir_fn(const char *full_path, size_t full_path_len,
  35. const char *file_pach, void *data);
  36. void for_each_file_in_pack_dir(const char *objdir,
  37. each_file_in_pack_dir_fn fn,
  38. void *data);
  39. /* A hook to report invalid files in pack directory */
  40. #define PACKDIR_FILE_PACK 1
  41. #define PACKDIR_FILE_IDX 2
  42. #define PACKDIR_FILE_GARBAGE 4
  43. extern void (*report_garbage)(unsigned seen_bits, const char *path);
  44. void reprepare_packed_git(struct repository *r);
  45. void install_packed_git(struct repository *r, struct packed_git *pack);
  46. struct packed_git *get_packed_git(struct repository *r);
  47. struct list_head *get_packed_git_mru(struct repository *r);
  48. struct multi_pack_index *get_multi_pack_index(struct repository *r);
  49. struct packed_git *get_all_packs(struct repository *r);
  50. /*
  51. * Give a rough count of objects in the repository. This sacrifices accuracy
  52. * for speed.
  53. */
  54. unsigned long repo_approximate_object_count(struct repository *r);
  55. #define approximate_object_count() repo_approximate_object_count(the_repository)
  56. struct packed_git *find_sha1_pack(const unsigned char *sha1,
  57. struct packed_git *packs);
  58. void pack_report(void);
  59. /*
  60. * mmap the index file for the specified packfile (if it is not
  61. * already mmapped). Return 0 on success.
  62. */
  63. int open_pack_index(struct packed_git *);
  64. /*
  65. * munmap the index file for the specified packfile (if it is
  66. * currently mmapped).
  67. */
  68. void close_pack_index(struct packed_git *);
  69. int close_pack_fd(struct packed_git *p);
  70. uint32_t get_pack_fanout(struct packed_git *p, uint32_t value);
  71. unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
  72. void close_pack_windows(struct packed_git *);
  73. void close_pack(struct packed_git *);
  74. void close_object_store(struct raw_object_store *o);
  75. void unuse_pack(struct pack_window **);
  76. void clear_delta_base_cache(void);
  77. struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
  78. /*
  79. * Unlink the .pack and associated extension files.
  80. * Does not unlink if 'force_delete' is false and the pack-file is
  81. * marked as ".keep".
  82. */
  83. void unlink_pack_path(const char *pack_name, int force_delete);
  84. /*
  85. * Make sure that a pointer access into an mmap'd index file is within bounds,
  86. * and can provide at least 8 bytes of data.
  87. *
  88. * Note that this is only necessary for variable-length segments of the file
  89. * (like the 64-bit extended offset table), as we compare the size to the
  90. * fixed-length parts when we open the file.
  91. */
  92. void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
  93. /*
  94. * Perform binary search on a pack-index for a given oid. Packfile is expected to
  95. * have a valid pack-index.
  96. *
  97. * See 'bsearch_hash' for more information.
  98. */
  99. int bsearch_pack(const struct object_id *oid, const struct packed_git *p, uint32_t *result);
  100. /*
  101. * Return the SHA-1 of the nth object within the specified packfile.
  102. * Open the index if it is not already open. The return value points
  103. * at the SHA-1 within the mmapped index. Return NULL if there is an
  104. * error.
  105. */
  106. const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
  107. /*
  108. * Like nth_packed_object_sha1, but write the data into the object specified by
  109. * the the first argument. Returns the first argument on success, and NULL on
  110. * error.
  111. */
  112. const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n);
  113. /*
  114. * Return the offset of the nth object within the specified packfile.
  115. * The index must already be opened.
  116. */
  117. off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
  118. /*
  119. * If the object named sha1 is present in the specified packfile,
  120. * return its offset within the packfile; otherwise, return 0.
  121. */
  122. off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
  123. int is_pack_valid(struct packed_git *);
  124. void *unpack_entry(struct repository *r, struct packed_git *, off_t, enum object_type *, unsigned long *);
  125. unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
  126. unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
  127. int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
  128. void release_pack_memory(size_t);
  129. /* global flag to enable extra checks when accessing packed objects */
  130. extern int do_check_packed_object_crc;
  131. int packed_object_info(struct repository *r,
  132. struct packed_git *pack,
  133. off_t offset, struct object_info *);
  134. void mark_bad_packed_object(struct packed_git *p, const unsigned char *sha1);
  135. const struct packed_git *has_packed_and_bad(struct repository *r, const unsigned char *sha1);
  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. */
  140. int find_pack_entry(struct repository *r, const struct object_id *oid, struct pack_entry *e);
  141. int has_object_pack(const struct object_id *oid);
  142. int has_pack_index(const unsigned char *sha1);
  143. /*
  144. * Return 1 if an object in a promisor packfile is or refers to the given
  145. * object, 0 otherwise.
  146. */
  147. int is_promisor_object(const struct object_id *oid);
  148. /*
  149. * Expose a function for fuzz testing.
  150. *
  151. * load_idx() parses a block of memory as a packfile index and puts the results
  152. * into a struct packed_git.
  153. *
  154. * This function should not be used directly. It is exposed here only so that we
  155. * have a convenient entry-point for fuzz testing. For real uses, you should
  156. * probably use open_pack_index() or parse_pack_index() instead.
  157. */
  158. int load_idx(const char *path, const unsigned int hashsz, void *idx_map,
  159. size_t idx_size, struct packed_git *p);
  160. #endif