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.

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