Andrew's git / gitweb.git /
d683112fd7bbab5df7e8cd5656b497cb8fd2bda1
   1#ifndef OBJECT_STORE_H
   2#define OBJECT_STORE_H
   3
   4#include "oidmap.h"
   5
   6struct alternate_object_database {
   7        struct alternate_object_database *next;
   8
   9        /* see alt_scratch_buf() */
  10        struct strbuf scratch;
  11        size_t base_len;
  12
  13        /*
  14         * Used to store the results of readdir(3) calls when searching
  15         * for unique abbreviated hashes.  This cache is never
  16         * invalidated, thus it's racy and not necessarily accurate.
  17         * That's fine for its purpose; don't use it for tasks requiring
  18         * greater accuracy!
  19         */
  20        char loose_objects_subdir_seen[256];
  21        struct oid_array loose_objects_cache;
  22
  23        /*
  24         * Path to the alternative object store. If this is a relative path,
  25         * it is relative to the current working directory.
  26         */
  27        char path[FLEX_ARRAY];
  28};
  29void prepare_alt_odb(struct repository *r);
  30char *compute_alternate_path(const char *path, struct strbuf *err);
  31typedef int alt_odb_fn(struct alternate_object_database *, void *);
  32int foreach_alt_odb(alt_odb_fn, void*);
  33
  34/*
  35 * Allocate a "struct alternate_object_database" but do _not_ actually
  36 * add it to the list of alternates.
  37 */
  38struct alternate_object_database *alloc_alt_odb(const char *dir);
  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 */
  44void 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 */
  51void add_to_alternates_memory(const char *dir);
  52
  53/*
  54 * Returns a scratch strbuf pre-filled with the alternate object directory,
  55 * including a trailing slash, which can be used to access paths in the
  56 * alternate. Always use this over direct access to alt->scratch, as it
  57 * cleans up any previous use of the scratch buffer.
  58 */
  59struct strbuf *alt_scratch_buf(struct alternate_object_database *alt);
  60
  61struct packed_git {
  62        struct packed_git *next;
  63        struct list_head mru;
  64        struct pack_window *windows;
  65        off_t pack_size;
  66        const void *index_data;
  67        size_t index_size;
  68        uint32_t num_objects;
  69        uint32_t num_bad_objects;
  70        unsigned char *bad_object_sha1;
  71        int index_version;
  72        time_t mtime;
  73        int pack_fd;
  74        int index;              /* for builtin/pack-objects.c */
  75        unsigned pack_local:1,
  76                 pack_keep:1,
  77                 pack_keep_in_core:1,
  78                 freshened:1,
  79                 do_not_close:1,
  80                 pack_promisor:1;
  81        unsigned char sha1[20];
  82        struct revindex_entry *revindex;
  83        /* something like ".git/objects/pack/xxxxx.pack" */
  84        char pack_name[FLEX_ARRAY]; /* more */
  85};
  86
  87struct raw_object_store {
  88        /*
  89         * Path to the repository's object store.
  90         * Cannot be NULL after initialization.
  91         */
  92        char *objectdir;
  93
  94        /* Path to extra alternate object database if not NULL */
  95        char *alternate_db;
  96
  97        struct alternate_object_database *alt_odb_list;
  98        struct alternate_object_database **alt_odb_tail;
  99
 100        /*
 101         * Objects that should be substituted by other objects
 102         * (see git-replace(1)).
 103         */
 104        struct oidmap *replace_map;
 105
 106        /*
 107         * private data
 108         *
 109         * should only be accessed directly by packfile.c
 110         */
 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        /*
 117         * A fast, rough count of the number of objects in the repository.
 118         * These two fields are not meant for direct access. Use
 119         * approximate_object_count() instead.
 120         */
 121        unsigned long approximate_object_count;
 122        unsigned approximate_object_count_valid : 1;
 123
 124        /*
 125         * Whether packed_git has already been populated with this repository's
 126         * packs.
 127         */
 128        unsigned packed_git_initialized : 1;
 129};
 130
 131struct raw_object_store *raw_object_store_new(void);
 132void raw_object_store_clear(struct raw_object_store *o);
 133
 134/*
 135 * Put in `buf` the name of the file in the local object database that
 136 * would be used to store a loose object with the specified sha1.
 137 */
 138void sha1_file_name(struct repository *r, struct strbuf *buf, const unsigned char *sha1);
 139
 140void *map_sha1_file(struct repository *r, const unsigned char *sha1, unsigned long *size);
 141
 142#endif /* OBJECT_STORE_H */