object-store.h

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