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