config: create core.multiPackIndex setting
[git/git.git] / object-store.h
CommitLineData
90c62155
SB
1#ifndef OBJECT_STORE_H
2#define OBJECT_STORE_H
3
d88f9fdf
SB
4#include "oidmap.h"
5
031dc927 6struct alternate_object_database {
0d4a1321
SB
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
77f012e8
SB
23 /*
24 * Path to the alternative object store. If this is a relative path,
25 * it is relative to the current working directory.
26 */
0d4a1321 27 char path[FLEX_ARRAY];
031dc927 28};
13068bf0 29void prepare_alt_odb(struct repository *r);
0d4a1321
SB
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
a80d72db
SB
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;
43fa44fa 74 int index; /* for builtin/pack-objects.c */
a80d72db
SB
75 unsigned pack_local:1,
76 pack_keep:1,
ed7e5fc3 77 pack_keep_in_core:1,
a80d72db
SB
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
4d80560c
DS
87struct multi_pack_index;
88
90c62155
SB
89struct raw_object_store {
90 /*
91 * Path to the repository's object store.
92 * Cannot be NULL after initialization.
93 */
94 char *objectdir;
95
96 /* Path to extra alternate object database if not NULL */
97 char *alternate_db;
031dc927
SB
98
99 struct alternate_object_database *alt_odb_list;
100 struct alternate_object_database **alt_odb_tail;
a80d72db 101
d88f9fdf
SB
102 /*
103 * Objects that should be substituted by other objects
104 * (see git-replace(1)).
105 */
c1274495 106 struct oidmap *replace_map;
d88f9fdf 107
c4d25228
DS
108 /*
109 * private data
110 *
111 * should only be accessed directly by packfile.c and midx.c
112 */
113 struct multi_pack_index *multi_pack_index;
114
a80d72db
SB
115 /*
116 * private data
117 *
118 * should only be accessed directly by packfile.c
119 */
120
121 struct packed_git *packed_git;
122 /* A most-recently-used ordered version of the packed_git list. */
123 struct list_head packed_git_mru;
5508f693 124
9a00580d
SB
125 /*
126 * A fast, rough count of the number of objects in the repository.
127 * These two fields are not meant for direct access. Use
128 * approximate_object_count() instead.
129 */
130 unsigned long approximate_object_count;
131 unsigned approximate_object_count_valid : 1;
132
5508f693
SB
133 /*
134 * Whether packed_git has already been populated with this repository's
135 * packs.
136 */
137 unsigned packed_git_initialized : 1;
90c62155
SB
138};
139
140struct raw_object_store *raw_object_store_new(void);
141void raw_object_store_clear(struct raw_object_store *o);
142
cf78ae4f
SB
143/*
144 * Put in `buf` the name of the file in the local object database that
145 * would be used to store a loose object with the specified sha1.
146 */
a68377b5 147void sha1_file_name(struct repository *r, struct strbuf *buf, const unsigned char *sha1);
cf78ae4f 148
bd27f50c 149void *map_sha1_file(struct repository *r, const unsigned char *sha1, unsigned long *size);
e35454fa 150
90c62155 151#endif /* OBJECT_STORE_H */