🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.35.2 / . / object.h
blob: cb556ab7753d5ddb01bc9421bbf490c0e684769b [file] [log] [blame]
Daniel Barkalow6eb8ae02005-04-18 18:39:48[diff] [blame]1#ifndef OBJECT_H
2#define OBJECT_H
3
Elijah Newrenef3ca952018-08-15 17:54:05[diff] [blame]4#include "cache.h"
5
Stefan Beller65ea9d42018-06-29 01:22:15[diff] [blame]6struct buffer_slab;
7
Stefan Beller99bf1152018-05-08 19:37:24[diff] [blame]8struct parsed_object_pool {
9 struct object **obj_hash;
10 int nr_objs, obj_hash_size;
Stefan Beller14ba97f2018-05-15 21:48:42[diff] [blame]11
12 /* TODO: migrate alloc_states to mem-pool? */
13 struct alloc_state *blob_state;
14 struct alloc_state *tree_state;
15 struct alloc_state *commit_state;
16 struct alloc_state *tag_state;
17 struct alloc_state *object_state;
Jonathan Nieder6a1a79f2018-05-15 23:42:16[diff] [blame]18
19 /* parent substitutions from .git/info/grafts and .git/shallow */
20 struct commit_graft **grafts;
21 int grafts_alloc, grafts_nr;
Stefan Bellereee45022018-05-17 22:51:52[diff] [blame]22
23 int is_shallow;
24 struct stat_validity *shallow_stat;
25 char *alternate_shallow_file;
Stefan Beller2f6c7672018-05-17 22:51:53[diff] [blame]26
27 int commit_graft_prepared;
Taylor Blauce163642020-07-08 21:10:53[diff] [blame]28 int substituted_parent;
Stefan Beller65ea9d42018-06-29 01:22:15[diff] [blame]29
30 struct buffer_slab *buffer_slab;
Stefan Beller99bf1152018-05-08 19:37:24[diff] [blame]31};
32
33struct parsed_object_pool *parsed_object_pool_new(void);
34void parsed_object_pool_clear(struct parsed_object_pool *o);
35
Daniel Barkalow6eb8ae02005-04-18 18:39:48[diff] [blame]36struct object_list {
37 struct object *item;
38 struct object_list *next;
39};
40
Linus Torvalds1f1e8952006-06-20 00:42:35[diff] [blame]41struct object_array {
42 unsigned int nr;
43 unsigned int alloc;
44 struct object_array_entry {
45 struct object *item;
Michael Haggerty31faeb22013-05-25 09:08:14[diff] [blame]46 /*
47 * name or NULL. If non-NULL, the memory pointed to
48 * is owned by this object *except* if it points at
49 * object_array_slopbuf, which is a static copy of the
50 * empty string.
51 */
52 char *name;
Jeff King9e0c3c42014-10-15 22:42:57[diff] [blame]53 char *path;
Martin Koeglere5709a42007-04-22 16:43:58[diff] [blame]54 unsigned mode;
Linus Torvalds1f1e8952006-06-20 00:42:35[diff] [blame]55 } *objects;
56};
57
Ævar Arnfjörð Bjarmason9865b6e2021-09-27 12:54:25[diff] [blame]58#define OBJECT_ARRAY_INIT { 0 }
Thiago Farina3cd47452010-08-29 02:04:17[diff] [blame]59
Nguyễn Thái Ngọc Duy208acbf2014-03-25 13:23:26[diff] [blame]60/*
61 * object flag allocation:
René Scharfe23c43192020-06-24 13:05:38[diff] [blame]62 * revision.h: 0---------10 15 23------26
Jonathan Tan9c1e6572021-05-04 21:16:01[diff] [blame]63 * fetch-pack.c: 01 67
Jonathan Tanec062832018-06-14 22:54:28[diff] [blame]64 * negotiator/default.c: 2--5
Nguyễn Thái Ngọc Duy3d1cf1e2018-03-06 10:16:15[diff] [blame]65 * walker.c: 0-2
Derrick Stoleeba3ca1e2018-07-20 16:33:13[diff] [blame]66 * upload-pack.c: 4 11-----14 16-----19
Nguyễn Thái Ngọc Duy3d1cf1e2018-03-06 10:16:15[diff] [blame]67 * builtin/blame.c: 12-13
68 * bisect.c: 16
69 * bundle.c: 16
brian m. carlson64472d12020-06-23 21:52:20[diff] [blame]70 * http-push.c: 11-----14
Derrick Stoleecb99a342019-10-24 13:40:42[diff] [blame]71 * commit-graph.c: 15
72 * commit-reach.c: 16-----19
Stefan Bellere5e5e0882018-04-10 21:26:19[diff] [blame]73 * sha1-name.c: 20
Nguyễn Thái Ngọc Duy3d1cf1e2018-03-06 10:16:15[diff] [blame]74 * list-objects-filter.c: 21
75 * builtin/fsck.c: 0--3
Derrick Stolee4ddc79b2020-09-17 18:11:51[diff] [blame]76 * builtin/gc.c: 0
Nguyễn Thái Ngọc Duy3d1cf1e2018-03-06 10:16:15[diff] [blame]77 * builtin/index-pack.c: 2021
Nguyễn Thái Ngọc Duy3d1cf1e2018-03-06 10:16:15[diff] [blame]78 * builtin/reflog.c: 10--12
Nguyễn Thái Ngọc Duy44cecbf2018-05-19 05:28:28[diff] [blame]79 * builtin/show-branch.c: 0-------------------------------------------26
Nguyễn Thái Ngọc Duy3d1cf1e2018-03-06 10:16:15[diff] [blame]80 * builtin/unpack-objects.c: 2021
Nguyễn Thái Ngọc Duy208acbf2014-03-25 13:23:26[diff] [blame]81 */
René Scharfe23c43192020-06-24 13:05:38[diff] [blame]82#define FLAG_BITS 28
Linus Torvalds885a86a2006-06-14 23:45:13[diff] [blame]83
Linus Torvalds19746322006-07-12 03:45:31[diff] [blame]84/*
85 * The object type is stored in 3 bits.
86 */
Daniel Barkalow6eb8ae02005-04-18 18:39:48[diff] [blame]87struct object {
88 unsigned parsed : 1;
Linus Torvalds885a86a2006-06-14 23:45:13[diff] [blame]89 unsigned type : TYPE_BITS;
90 unsigned flags : FLAG_BITS;
brian m. carlsonf2fd0762015-11-10 02:22:28[diff] [blame]91 struct object_id oid;
Daniel Barkalow6eb8ae02005-04-18 18:39:48[diff] [blame]92};
93
Denton Liu55454422019-04-29 08:28:14[diff] [blame]94const char *type_name(unsigned int type);
95int type_from_string_gently(const char *str, ssize_t, int gentle);
Johannes Schindelinfe8e3b72014-09-10 13:52:44[diff] [blame]96#define type_from_string(str) type_from_string_gently(str, -1, 0)
Linus Torvalds885a86a2006-06-14 23:45:13[diff] [blame]97
Michael Haggerty33bef7e2014-02-28 16:29:17[diff] [blame]98/*
99 * Return the current number of buckets in the object hashmap.
100 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]101unsigned int get_max_object_index(void);
Michael Haggerty33bef7e2014-02-28 16:29:17[diff] [blame]102
103/*
104 * Return the object from the specified bucket in the object hashmap.
105 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]106struct object *get_indexed_object(unsigned int);
Linus Torvalds3e4339e2006-06-18 18:45:02[diff] [blame]107
Junio C Hamano628b06d2008-09-10 19:22:35[diff] [blame]108/*
109 * This can be used to see if we have heard of the object before, but
110 * it can return "yes we have, and here is a half-initialised object"
111 * for an object that we haven't loaded/parsed yet.
112 *
113 * When parsing a commit to create an in-core commit object, its
114 * parents list holds commit objects that represent its parents, but
115 * they are expected to be lazily initialized and do not know what
116 * their trees or parents are yet. When this function returns such a
117 * half-initialised objects, the caller is expected to initialize them
118 * by calling parse_object() on them.
119 */
Jeff Kingd0229ab2019-06-20 07:41:14[diff] [blame]120struct object *lookup_object(struct repository *r, const struct object_id *oid);
Daniel Barkalow6eb8ae02005-04-18 18:39:48[diff] [blame]121
Jeff Kinga3785092019-06-20 07:41:21[diff] [blame]122void *create_object(struct repository *r, const struct object_id *oid, void *obj);
Daniel Barkalow6eb8ae02005-04-18 18:39:48[diff] [blame]123
Abhishek Kumar6da43d92020-06-17 09:14:08[diff] [blame]124void *object_as_type(struct object *obj, enum object_type type, int quiet);
Jeff King8ff226a2014-07-13 06:42:03[diff] [blame]125
Jeff King75a95492013-03-17 08:22:36[diff] [blame]126/*
127 * Returns the object, having parsed it to find out what it is.
128 *
129 * Returns NULL if the object is missing or corrupt.
130 */
Stefan Beller8e4b0b62018-06-29 01:22:19[diff] [blame]131struct object *parse_object(struct repository *r, const struct object_id *oid);
Daniel Barkalowe9eefa62005-04-28 14:46:33[diff] [blame]132
Jeff King75a95492013-03-17 08:22:36[diff] [blame]133/*
134 * Like parse_object, but will die() instead of returning NULL. If the
135 * "name" parameter is not NULL, it is included in the error message
brian m. carlsonc251c832017-05-06 22:10:38[diff] [blame]136 * (otherwise, the hex object ID is given).
Jeff King75a95492013-03-17 08:22:36[diff] [blame]137 */
brian m. carlsonc251c832017-05-06 22:10:38[diff] [blame]138struct object *parse_object_or_die(const struct object_id *oid, const char *name);
Jeff King75a95492013-03-17 08:22:36[diff] [blame]139
Junio C Hamano9f613dd2006-09-15 20:30:02[diff] [blame]140/* Given the result of read_sha1_file(), returns the object after
141 * parsing it. eaten_p indicates if the object has a borrowed copy
142 * of buffer and the caller should not free() it.
143 */
Stefan Beller108ed1a2018-06-29 01:22:18[diff] [blame]144struct object *parse_object_buffer(struct repository *r, const struct object_id *oid, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
Junio C Hamano9f613dd2006-09-15 20:30:02[diff] [blame]145
Jeff King542d6ab2021-06-22 16:05:31[diff] [blame]146/*
147 * Allocate and return an object struct, even if you do not know the type of
148 * the object. The returned object may have its "type" field set to a real type
149 * (if somebody previously called lookup_blob(), etc), or it may be set to
150 * OBJ_NONE. In the latter case, subsequent calls to lookup_blob(), etc, will
151 * set the type field as appropriate.
152 *
153 * Use this when you do not know the expected type of an object and want to
154 * avoid parsing it for efficiency reasons. Try to avoid it otherwise; it
155 * may allocate excess memory, since the returned object must be as large as
156 * the maximum struct of any type.
157 */
Jeff King45a187c2021-04-13 07:16:36[diff] [blame]158struct object *lookup_unknown_object(struct repository *r, const struct object_id *oid);
barkalow@iabervon.org66e481b2005-08-02 23:45:48[diff] [blame]159
Jeff King74630642021-06-22 16:06:41[diff] [blame]160/*
161 * Dispatch to the appropriate lookup_blob(), lookup_commit(), etc, based on
162 * "type".
163 */
164struct object *lookup_object_by_type(struct repository *r, const struct object_id *oid,
165 enum object_type type);
166
Junio C Hamanoa6080a02007-06-07 07:04:01[diff] [blame]167struct object_list *object_list_insert(struct object *item,
barkalow@iabervon.org66e481b2005-08-02 23:45:48[diff] [blame]168 struct object_list **list_p);
169
barkalow@iabervon.org66e481b2005-08-02 23:45:48[diff] [blame]170int object_list_contains(struct object_list *list, struct object *obj);
171
Jeff Kingacac50d2020-02-13 02:16:33[diff] [blame]172void object_list_free(struct object_list **list);
173
Linus Torvalds1f1e8952006-06-20 00:42:35[diff] [blame]174/* Object array handling .. */
175void add_object_array(struct object *obj, const char *name, struct object_array *array);
Jeff King9e0c3c42014-10-15 22:42:57[diff] [blame]176void add_object_array_with_path(struct object *obj, const char *name, struct object_array *array, unsigned mode, const char *path);
Michael Haggertyaeb4a512013-05-25 09:08:08[diff] [blame]177
Martin Ågren71992032017-09-22 23:34:53[diff] [blame]178/*
179 * Returns NULL if the array is empty. Otherwise, returns the last object
180 * after removing its entry from the array. Other resources associated
181 * with that object are left in an unspecified state and should not be
182 * examined.
183 */
184struct object *object_array_pop(struct object_array *array);
185
Michael Haggertyaeb4a512013-05-25 09:08:08[diff] [blame]186typedef int (*object_array_each_func_t)(struct object_array_entry *, void *);
187
188/*
189 * Apply want to each entry in array, retaining only the entries for
190 * which the function returns true. Preserve the order of the entries
191 * that are retained.
192 */
193void object_array_filter(struct object_array *array,
194 object_array_each_func_t want, void *cb_data);
195
Michael Haggerty15065102013-05-25 09:08:10[diff] [blame]196/*
197 * Remove from array all but the first entry with a given name.
198 * Warning: this function uses an O(N^2) algorithm.
199 */
200void object_array_remove_duplicates(struct object_array *array);
Linus Torvalds1f1e8952006-06-20 00:42:35[diff] [blame]201
Jeff King46be8232014-10-15 22:34:34[diff] [blame]202/*
203 * Remove any objects from the array, freeing all used memory; afterwards
204 * the array is ready to store more objects with add_object_array().
205 */
206void object_array_clear(struct object_array *array);
207
Heiko Voigtbcc0a3e2012-03-29 07:21:21[diff] [blame]208void clear_object_flags(unsigned flags);
209
René Scharfe4ad315f2017-12-25 17:44:58[diff] [blame]210/*
René Scharfecd888842020-10-31 12:46:08[diff] [blame]211 * Clear the specified object flags from all in-core commit objects from
212 * the specified repository.
René Scharfe4ad315f2017-12-25 17:44:58[diff] [blame]213 */
René Scharfecd888842020-10-31 12:46:08[diff] [blame]214void repo_clear_commit_marks(struct repository *r, unsigned int flags);
René Scharfe4ad315f2017-12-25 17:44:58[diff] [blame]215
Daniel Barkalow6eb8ae02005-04-18 18:39:48[diff] [blame]216#endif /* OBJECT_H */