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.

386 lines
12KB

  1. #ifndef OBJECT_STORE_H
  2. #define OBJECT_STORE_H
  3. #include "cache.h"
  4. #include "oidmap.h"
  5. #include "list.h"
  6. #include "sha1-array.h"
  7. #include "strbuf.h"
  8. struct object_directory {
  9. struct object_directory *next;
  10. /*
  11. * Used to store the results of readdir(3) calls when we are OK
  12. * sacrificing accuracy due to races for speed. That includes
  13. * object existence with OBJECT_INFO_QUICK, as well as
  14. * our search for unique abbreviated hashes. Don't use it for tasks
  15. * requiring greater accuracy!
  16. *
  17. * Be sure to call odb_load_loose_cache() before using.
  18. */
  19. char loose_objects_subdir_seen[256];
  20. struct oid_array loose_objects_cache[256];
  21. /*
  22. * Path to the alternative object store. If this is a relative path,
  23. * it is relative to the current working directory.
  24. */
  25. char *path;
  26. };
  27. void prepare_alt_odb(struct repository *r);
  28. char *compute_alternate_path(const char *path, struct strbuf *err);
  29. typedef int alt_odb_fn(struct object_directory *, void *);
  30. int foreach_alt_odb(alt_odb_fn, void*);
  31. typedef void alternate_ref_fn(const struct object_id *oid, void *);
  32. void for_each_alternate_ref(alternate_ref_fn, void *);
  33. /*
  34. * Add the directory to the on-disk alternates file; the new entry will also
  35. * take effect in the current process.
  36. */
  37. void add_to_alternates_file(const char *dir);
  38. /*
  39. * Add the directory to the in-memory list of alternates (along with any
  40. * recursive alternates it points to), but do not modify the on-disk alternates
  41. * file.
  42. */
  43. void add_to_alternates_memory(const char *dir);
  44. /*
  45. * Populate and return the loose object cache array corresponding to the
  46. * given object ID.
  47. */
  48. struct oid_array *odb_loose_cache(struct object_directory *odb,
  49. const struct object_id *oid);
  50. /* Empty the loose object cache for the specified object directory. */
  51. void odb_clear_loose_cache(struct object_directory *odb);
  52. struct packed_git {
  53. struct packed_git *next;
  54. struct list_head mru;
  55. struct pack_window *windows;
  56. off_t pack_size;
  57. const void *index_data;
  58. size_t index_size;
  59. uint32_t num_objects;
  60. uint32_t num_bad_objects;
  61. unsigned char *bad_object_sha1;
  62. int index_version;
  63. time_t mtime;
  64. int pack_fd;
  65. int index; /* for builtin/pack-objects.c */
  66. unsigned pack_local:1,
  67. pack_keep:1,
  68. pack_keep_in_core:1,
  69. freshened:1,
  70. do_not_close:1,
  71. pack_promisor:1,
  72. multi_pack_index:1;
  73. unsigned char hash[GIT_MAX_RAWSZ];
  74. struct revindex_entry *revindex;
  75. /* something like ".git/objects/pack/xxxxx.pack" */
  76. char pack_name[FLEX_ARRAY]; /* more */
  77. };
  78. struct multi_pack_index;
  79. struct raw_object_store {
  80. /*
  81. * Set of all object directories; the main directory is first (and
  82. * cannot be NULL after initialization). Subsequent directories are
  83. * alternates.
  84. */
  85. struct object_directory *odb;
  86. struct object_directory **odb_tail;
  87. int loaded_alternates;
  88. /*
  89. * A list of alternate object directories loaded from the environment;
  90. * this should not generally need to be accessed directly, but will
  91. * populate the "odb" list when prepare_alt_odb() is run.
  92. */
  93. char *alternate_db;
  94. /*
  95. * Objects that should be substituted by other objects
  96. * (see git-replace(1)).
  97. */
  98. struct oidmap *replace_map;
  99. struct commit_graph *commit_graph;
  100. unsigned commit_graph_attempted : 1; /* if loading has been attempted */
  101. /*
  102. * private data
  103. *
  104. * should only be accessed directly by packfile.c and midx.c
  105. */
  106. struct multi_pack_index *multi_pack_index;
  107. /*
  108. * private data
  109. *
  110. * should only be accessed directly by packfile.c
  111. */
  112. struct packed_git *packed_git;
  113. /* A most-recently-used ordered version of the packed_git list. */
  114. struct list_head packed_git_mru;
  115. /*
  116. * A fast, rough count of the number of objects in the repository.
  117. * These two fields are not meant for direct access. Use
  118. * approximate_object_count() instead.
  119. */
  120. unsigned long approximate_object_count;
  121. unsigned approximate_object_count_valid : 1;
  122. /*
  123. * Whether packed_git has already been populated with this repository's
  124. * packs.
  125. */
  126. unsigned packed_git_initialized : 1;
  127. };
  128. struct raw_object_store *raw_object_store_new(void);
  129. void raw_object_store_clear(struct raw_object_store *o);
  130. /*
  131. * Put in `buf` the name of the file in the local object database that
  132. * would be used to store a loose object with the specified oid.
  133. */
  134. const char *loose_object_path(struct repository *r, struct strbuf *buf,
  135. const struct object_id *oid);
  136. void *map_loose_object(struct repository *r, const struct object_id *oid,
  137. unsigned long *size);
  138. void *read_object_file_extended(struct repository *r,
  139. const struct object_id *oid,
  140. enum object_type *type,
  141. unsigned long *size, int lookup_replace);
  142. static inline void *repo_read_object_file(struct repository *r,
  143. const struct object_id *oid,
  144. enum object_type *type,
  145. unsigned long *size)
  146. {
  147. return read_object_file_extended(r, oid, type, size, 1);
  148. }
  149. #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
  150. #define read_object_file(oid, type, size) repo_read_object_file(the_repository, oid, type, size)
  151. #endif
  152. /* Read and unpack an object file into memory, write memory to an object file */
  153. int oid_object_info(struct repository *r, const struct object_id *, unsigned long *);
  154. int hash_object_file(const void *buf, unsigned long len,
  155. const char *type, struct object_id *oid);
  156. int write_object_file(const void *buf, unsigned long len,
  157. const char *type, struct object_id *oid);
  158. int hash_object_file_literally(const void *buf, unsigned long len,
  159. const char *type, struct object_id *oid,
  160. unsigned flags);
  161. int pretend_object_file(void *, unsigned long, enum object_type,
  162. struct object_id *oid);
  163. int force_object_loose(const struct object_id *oid, time_t mtime);
  164. /*
  165. * Open the loose object at path, check its hash, and return the contents,
  166. * type, and size. If the object is a blob, then "contents" may return NULL,
  167. * to allow streaming of large blobs.
  168. *
  169. * Returns 0 on success, negative on error (details may be written to stderr).
  170. */
  171. int read_loose_object(const char *path,
  172. const struct object_id *expected_oid,
  173. enum object_type *type,
  174. unsigned long *size,
  175. void **contents);
  176. #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
  177. #define has_sha1_file_with_flags(sha1, flags) repo_has_sha1_file_with_flags(the_repository, sha1, flags)
  178. #define has_sha1_file(sha1) repo_has_sha1_file(the_repository, sha1)
  179. #endif
  180. /* Same as the above, except for struct object_id. */
  181. int repo_has_object_file(struct repository *r, const struct object_id *oid);
  182. int repo_has_object_file_with_flags(struct repository *r,
  183. const struct object_id *oid, int flags);
  184. #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
  185. #define has_object_file(oid) repo_has_object_file(the_repository, oid)
  186. #define has_object_file_with_flags(oid, flags) repo_has_object_file_with_flags(the_repository, oid, flags)
  187. #endif
  188. /*
  189. * Return true iff an alternate object database has a loose object
  190. * with the specified name. This function does not respect replace
  191. * references.
  192. */
  193. int has_loose_object_nonlocal(const struct object_id *);
  194. void assert_oid_type(const struct object_id *oid, enum object_type expect);
  195. struct object_info {
  196. /* Request */
  197. enum object_type *typep;
  198. unsigned long *sizep;
  199. off_t *disk_sizep;
  200. unsigned char *delta_base_sha1;
  201. struct strbuf *type_name;
  202. void **contentp;
  203. /* Response */
  204. enum {
  205. OI_CACHED,
  206. OI_LOOSE,
  207. OI_PACKED,
  208. OI_DBCACHED
  209. } whence;
  210. union {
  211. /*
  212. * struct {
  213. * ... Nothing to expose in this case
  214. * } cached;
  215. * struct {
  216. * ... Nothing to expose in this case
  217. * } loose;
  218. */
  219. struct {
  220. struct packed_git *pack;
  221. off_t offset;
  222. unsigned int is_delta;
  223. } packed;
  224. } u;
  225. };
  226. /*
  227. * Initializer for a "struct object_info" that wants no items. You may
  228. * also memset() the memory to all-zeroes.
  229. */
  230. #define OBJECT_INFO_INIT {NULL}
  231. /* Invoke lookup_replace_object() on the given hash */
  232. #define OBJECT_INFO_LOOKUP_REPLACE 1
  233. /* Allow reading from a loose object file of unknown/bogus type */
  234. #define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 2
  235. /* Do not check cached storage */
  236. #define OBJECT_INFO_SKIP_CACHED 4
  237. /* Do not retry packed storage after checking packed and loose storage */
  238. #define OBJECT_INFO_QUICK 8
  239. /* Do not check loose object */
  240. #define OBJECT_INFO_IGNORE_LOOSE 16
  241. /*
  242. * Do not attempt to fetch the object if missing (even if fetch_is_missing is
  243. * nonzero).
  244. */
  245. #define OBJECT_INFO_SKIP_FETCH_OBJECT 32
  246. /*
  247. * This is meant for bulk prefetching of missing blobs in a partial
  248. * clone. Implies OBJECT_INFO_SKIP_FETCH_OBJECT and OBJECT_INFO_QUICK
  249. */
  250. #define OBJECT_INFO_FOR_PREFETCH (OBJECT_INFO_SKIP_FETCH_OBJECT | OBJECT_INFO_QUICK)
  251. int oid_object_info_extended(struct repository *r,
  252. const struct object_id *,
  253. struct object_info *, unsigned flags);
  254. /*
  255. * Iterate over the files in the loose-object parts of the object
  256. * directory "path", triggering the following callbacks:
  257. *
  258. * - loose_object is called for each loose object we find.
  259. *
  260. * - loose_cruft is called for any files that do not appear to be
  261. * loose objects. Note that we only look in the loose object
  262. * directories "objects/[0-9a-f]{2}/", so we will not report
  263. * "objects/foobar" as cruft.
  264. *
  265. * - loose_subdir is called for each top-level hashed subdirectory
  266. * of the object directory (e.g., "$OBJDIR/f0"). It is called
  267. * after the objects in the directory are processed.
  268. *
  269. * Any callback that is NULL will be ignored. Callbacks returning non-zero
  270. * will end the iteration.
  271. *
  272. * In the "buf" variant, "path" is a strbuf which will also be used as a
  273. * scratch buffer, but restored to its original contents before
  274. * the function returns.
  275. */
  276. typedef int each_loose_object_fn(const struct object_id *oid,
  277. const char *path,
  278. void *data);
  279. typedef int each_loose_cruft_fn(const char *basename,
  280. const char *path,
  281. void *data);
  282. typedef int each_loose_subdir_fn(unsigned int nr,
  283. const char *path,
  284. void *data);
  285. int for_each_file_in_obj_subdir(unsigned int subdir_nr,
  286. struct strbuf *path,
  287. each_loose_object_fn obj_cb,
  288. each_loose_cruft_fn cruft_cb,
  289. each_loose_subdir_fn subdir_cb,
  290. void *data);
  291. int for_each_loose_file_in_objdir(const char *path,
  292. each_loose_object_fn obj_cb,
  293. each_loose_cruft_fn cruft_cb,
  294. each_loose_subdir_fn subdir_cb,
  295. void *data);
  296. int for_each_loose_file_in_objdir_buf(struct strbuf *path,
  297. each_loose_object_fn obj_cb,
  298. each_loose_cruft_fn cruft_cb,
  299. each_loose_subdir_fn subdir_cb,
  300. void *data);
  301. /* Flags for for_each_*_object() below. */
  302. enum for_each_object_flags {
  303. /* Iterate only over local objects, not alternates. */
  304. FOR_EACH_OBJECT_LOCAL_ONLY = (1<<0),
  305. /* Only iterate over packs obtained from the promisor remote. */
  306. FOR_EACH_OBJECT_PROMISOR_ONLY = (1<<1),
  307. /*
  308. * Visit objects within a pack in packfile order rather than .idx order
  309. */
  310. FOR_EACH_OBJECT_PACK_ORDER = (1<<2),
  311. };
  312. /*
  313. * Iterate over all accessible loose objects without respect to
  314. * reachability. By default, this includes both local and alternate objects.
  315. * The order in which objects are visited is unspecified.
  316. *
  317. * Any flags specific to packs are ignored.
  318. */
  319. int for_each_loose_object(each_loose_object_fn, void *,
  320. enum for_each_object_flags flags);
  321. /*
  322. * Iterate over all accessible packed objects without respect to reachability.
  323. * By default, this includes both local and alternate packs.
  324. *
  325. * Note that some objects may appear twice if they are found in multiple packs.
  326. * Each pack is visited in an unspecified order. By default, objects within a
  327. * pack are visited in pack-idx order (i.e., sorted by oid).
  328. */
  329. typedef int each_packed_object_fn(const struct object_id *oid,
  330. struct packed_git *pack,
  331. uint32_t pos,
  332. void *data);
  333. int for_each_object_in_pack(struct packed_git *p,
  334. each_packed_object_fn, void *data,
  335. enum for_each_object_flags flags);
  336. int for_each_packed_object(each_packed_object_fn, void *,
  337. enum for_each_object_flags flags);
  338. #endif /* OBJECT_STORE_H */