]>
Commit | Line | Data |
---|---|---|
1 | #ifndef OBJECT_H | |
2 | #define OBJECT_H | |
3 | ||
4 | #include "hash-ll.h" | |
5 | ||
6 | struct buffer_slab; | |
7 | struct repository; | |
8 | ||
9 | struct parsed_object_pool { | |
10 | struct object **obj_hash; | |
11 | int nr_objs, obj_hash_size; | |
12 | ||
13 | /* TODO: migrate alloc_states to mem-pool? */ | |
14 | struct alloc_state *blob_state; | |
15 | struct alloc_state *tree_state; | |
16 | struct alloc_state *commit_state; | |
17 | struct alloc_state *tag_state; | |
18 | struct alloc_state *object_state; | |
19 | ||
20 | /* parent substitutions from .git/info/grafts and .git/shallow */ | |
21 | struct commit_graft **grafts; | |
22 | int grafts_alloc, grafts_nr; | |
23 | ||
24 | int is_shallow; | |
25 | struct stat_validity *shallow_stat; | |
26 | char *alternate_shallow_file; | |
27 | ||
28 | int commit_graft_prepared; | |
29 | int substituted_parent; | |
30 | ||
31 | struct buffer_slab *buffer_slab; | |
32 | }; | |
33 | ||
34 | struct parsed_object_pool *parsed_object_pool_new(void); | |
35 | void parsed_object_pool_clear(struct parsed_object_pool *o); | |
36 | ||
37 | struct object_list { | |
38 | struct object *item; | |
39 | struct object_list *next; | |
40 | }; | |
41 | ||
42 | struct object_array { | |
43 | unsigned int nr; | |
44 | unsigned int alloc; | |
45 | struct object_array_entry { | |
46 | struct object *item; | |
47 | /* | |
48 | * name or NULL. If non-NULL, the memory pointed to | |
49 | * is owned by this object *except* if it points at | |
50 | * object_array_slopbuf, which is a static copy of the | |
51 | * empty string. | |
52 | */ | |
53 | char *name; | |
54 | char *path; | |
55 | unsigned mode; | |
56 | } *objects; | |
57 | }; | |
58 | ||
59 | #define OBJECT_ARRAY_INIT { 0 } | |
60 | ||
61 | /* | |
62 | * object flag allocation: | |
63 | * revision.h: 0---------10 15 23------27 | |
64 | * fetch-pack.c: 01 67 | |
65 | * negotiator/default.c: 2--5 | |
66 | * walker.c: 0-2 | |
67 | * upload-pack.c: 4 11-----14 16-----19 | |
68 | * builtin/blame.c: 12-13 | |
69 | * bisect.c: 16 | |
70 | * bundle.c: 16 | |
71 | * http-push.c: 11-----14 | |
72 | * commit-graph.c: 15 | |
73 | * commit-reach.c: 16-----19 | |
74 | * sha1-name.c: 20 | |
75 | * list-objects-filter.c: 21 | |
76 | * builtin/fsck.c: 0--3 | |
77 | * builtin/gc.c: 0 | |
78 | * builtin/index-pack.c: 2021 | |
79 | * reflog.c: 10--12 | |
80 | * builtin/show-branch.c: 0-------------------------------------------26 | |
81 | * builtin/unpack-objects.c: 2021 | |
82 | */ | |
83 | #define FLAG_BITS 28 | |
84 | ||
85 | #define TYPE_BITS 3 | |
86 | ||
87 | /* | |
88 | * Values in this enum (except those outside the 3 bit range) are part | |
89 | * of pack file format. See gitformat-pack(5) for more information. | |
90 | */ | |
91 | enum object_type { | |
92 | OBJ_BAD = -1, | |
93 | OBJ_NONE = 0, | |
94 | OBJ_COMMIT = 1, | |
95 | OBJ_TREE = 2, | |
96 | OBJ_BLOB = 3, | |
97 | OBJ_TAG = 4, | |
98 | /* 5 for future expansion */ | |
99 | OBJ_OFS_DELTA = 6, | |
100 | OBJ_REF_DELTA = 7, | |
101 | OBJ_ANY, | |
102 | OBJ_MAX | |
103 | }; | |
104 | ||
105 | /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */ | |
106 | #define S_IFINVALID 0030000 | |
107 | ||
108 | /* | |
109 | * A "directory link" is a link to another git directory. | |
110 | * | |
111 | * The value 0160000 is not normally a valid mode, and | |
112 | * also just happens to be S_IFDIR + S_IFLNK | |
113 | */ | |
114 | #define S_IFGITLINK 0160000 | |
115 | #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK) | |
116 | ||
117 | #define S_ISSPARSEDIR(m) ((m) == S_IFDIR) | |
118 | ||
119 | static inline enum object_type object_type(unsigned int mode) | |
120 | { | |
121 | return S_ISDIR(mode) ? OBJ_TREE : | |
122 | S_ISGITLINK(mode) ? OBJ_COMMIT : | |
123 | OBJ_BLOB; | |
124 | } | |
125 | ||
126 | #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644) | |
127 | static inline unsigned int create_ce_mode(unsigned int mode) | |
128 | { | |
129 | if (S_ISLNK(mode)) | |
130 | return S_IFLNK; | |
131 | if (S_ISSPARSEDIR(mode)) | |
132 | return S_IFDIR; | |
133 | if (S_ISDIR(mode) || S_ISGITLINK(mode)) | |
134 | return S_IFGITLINK; | |
135 | return S_IFREG | ce_permissions(mode); | |
136 | } | |
137 | ||
138 | static inline unsigned int canon_mode(unsigned int mode) | |
139 | { | |
140 | if (S_ISREG(mode)) | |
141 | return S_IFREG | ce_permissions(mode); | |
142 | if (S_ISLNK(mode)) | |
143 | return S_IFLNK; | |
144 | if (S_ISDIR(mode)) | |
145 | return S_IFDIR; | |
146 | return S_IFGITLINK; | |
147 | } | |
148 | ||
149 | /* | |
150 | * The object type is stored in 3 bits. | |
151 | */ | |
152 | struct object { | |
153 | unsigned parsed : 1; | |
154 | unsigned type : TYPE_BITS; | |
155 | unsigned flags : FLAG_BITS; | |
156 | struct object_id oid; | |
157 | }; | |
158 | ||
159 | const char *type_name(unsigned int type); | |
160 | int type_from_string_gently(const char *str, ssize_t, int gentle); | |
161 | #define type_from_string(str) type_from_string_gently(str, -1, 0) | |
162 | ||
163 | /* | |
164 | * Return the current number of buckets in the object hashmap. | |
165 | */ | |
166 | unsigned int get_max_object_index(void); | |
167 | ||
168 | /* | |
169 | * Return the object from the specified bucket in the object hashmap. | |
170 | */ | |
171 | struct object *get_indexed_object(unsigned int); | |
172 | ||
173 | /* | |
174 | * This can be used to see if we have heard of the object before, but | |
175 | * it can return "yes we have, and here is a half-initialised object" | |
176 | * for an object that we haven't loaded/parsed yet. | |
177 | * | |
178 | * When parsing a commit to create an in-core commit object, its | |
179 | * parents list holds commit objects that represent its parents, but | |
180 | * they are expected to be lazily initialized and do not know what | |
181 | * their trees or parents are yet. When this function returns such a | |
182 | * half-initialised objects, the caller is expected to initialize them | |
183 | * by calling parse_object() on them. | |
184 | */ | |
185 | struct object *lookup_object(struct repository *r, const struct object_id *oid); | |
186 | ||
187 | void *create_object(struct repository *r, const struct object_id *oid, void *obj); | |
188 | ||
189 | void *object_as_type(struct object *obj, enum object_type type, int quiet); | |
190 | ||
191 | /* | |
192 | * Returns the object, having parsed it to find out what it is. | |
193 | * | |
194 | * Returns NULL if the object is missing or corrupt. | |
195 | */ | |
196 | enum parse_object_flags { | |
197 | PARSE_OBJECT_SKIP_HASH_CHECK = 1 << 0, | |
198 | }; | |
199 | struct object *parse_object(struct repository *r, const struct object_id *oid); | |
200 | struct object *parse_object_with_flags(struct repository *r, | |
201 | const struct object_id *oid, | |
202 | enum parse_object_flags flags); | |
203 | ||
204 | /* | |
205 | * Like parse_object, but will die() instead of returning NULL. If the | |
206 | * "name" parameter is not NULL, it is included in the error message | |
207 | * (otherwise, the hex object ID is given). | |
208 | */ | |
209 | struct object *parse_object_or_die(const struct object_id *oid, const char *name); | |
210 | ||
211 | /* Given the result of read_sha1_file(), returns the object after | |
212 | * parsing it. eaten_p indicates if the object has a borrowed copy | |
213 | * of buffer and the caller should not free() it. | |
214 | */ | |
215 | struct object *parse_object_buffer(struct repository *r, const struct object_id *oid, enum object_type type, unsigned long size, void *buffer, int *eaten_p); | |
216 | ||
217 | /* | |
218 | * Allocate and return an object struct, even if you do not know the type of | |
219 | * the object. The returned object may have its "type" field set to a real type | |
220 | * (if somebody previously called lookup_blob(), etc), or it may be set to | |
221 | * OBJ_NONE. In the latter case, subsequent calls to lookup_blob(), etc, will | |
222 | * set the type field as appropriate. | |
223 | * | |
224 | * Use this when you do not know the expected type of an object and want to | |
225 | * avoid parsing it for efficiency reasons. Try to avoid it otherwise; it | |
226 | * may allocate excess memory, since the returned object must be as large as | |
227 | * the maximum struct of any type. | |
228 | */ | |
229 | struct object *lookup_unknown_object(struct repository *r, const struct object_id *oid); | |
230 | ||
231 | /* | |
232 | * Dispatch to the appropriate lookup_blob(), lookup_commit(), etc, based on | |
233 | * "type". | |
234 | */ | |
235 | struct object *lookup_object_by_type(struct repository *r, const struct object_id *oid, | |
236 | enum object_type type); | |
237 | ||
238 | struct object_list *object_list_insert(struct object *item, | |
239 | struct object_list **list_p); | |
240 | ||
241 | int object_list_contains(struct object_list *list, struct object *obj); | |
242 | ||
243 | void object_list_free(struct object_list **list); | |
244 | ||
245 | /* Object array handling .. */ | |
246 | void add_object_array(struct object *obj, const char *name, struct object_array *array); | |
247 | void add_object_array_with_path(struct object *obj, const char *name, struct object_array *array, unsigned mode, const char *path); | |
248 | ||
249 | /* | |
250 | * Returns NULL if the array is empty. Otherwise, returns the last object | |
251 | * after removing its entry from the array. Other resources associated | |
252 | * with that object are left in an unspecified state and should not be | |
253 | * examined. | |
254 | */ | |
255 | struct object *object_array_pop(struct object_array *array); | |
256 | ||
257 | typedef int (*object_array_each_func_t)(struct object_array_entry *, void *); | |
258 | ||
259 | /* | |
260 | * Apply want to each entry in array, retaining only the entries for | |
261 | * which the function returns true. Preserve the order of the entries | |
262 | * that are retained. | |
263 | */ | |
264 | void object_array_filter(struct object_array *array, | |
265 | object_array_each_func_t want, void *cb_data); | |
266 | ||
267 | /* | |
268 | * Remove from array all but the first entry with a given name. | |
269 | * Warning: this function uses an O(N^2) algorithm. | |
270 | */ | |
271 | void object_array_remove_duplicates(struct object_array *array); | |
272 | ||
273 | /* | |
274 | * Remove any objects from the array, freeing all used memory; afterwards | |
275 | * the array is ready to store more objects with add_object_array(). | |
276 | */ | |
277 | void object_array_clear(struct object_array *array); | |
278 | ||
279 | void clear_object_flags(unsigned flags); | |
280 | ||
281 | /* | |
282 | * Clear the specified object flags from all in-core commit objects from | |
283 | * the specified repository. | |
284 | */ | |
285 | void repo_clear_commit_marks(struct repository *r, unsigned int flags); | |
286 | ||
287 | #endif /* OBJECT_H */ |