alloc: allow arbitrary repositories for alloc functions
[git/git.git] / object.h
1 #ifndef OBJECT_H
2 #define OBJECT_H
3
4 struct parsed_object_pool {
5 struct object **obj_hash;
6 int nr_objs, obj_hash_size;
7
8 /* TODO: migrate alloc_states to mem-pool? */
9 struct alloc_state *blob_state;
10 struct alloc_state *tree_state;
11 struct alloc_state *commit_state;
12 struct alloc_state *tag_state;
13 struct alloc_state *object_state;
14 unsigned commit_count;
15 };
16
17 struct parsed_object_pool *parsed_object_pool_new(void);
18 void parsed_object_pool_clear(struct parsed_object_pool *o);
19
20 struct object_list {
21 struct object *item;
22 struct object_list *next;
23 };
24
25 struct object_array {
26 unsigned int nr;
27 unsigned int alloc;
28 struct object_array_entry {
29 struct object *item;
30 /*
31 * name or NULL. If non-NULL, the memory pointed to
32 * is owned by this object *except* if it points at
33 * object_array_slopbuf, which is a static copy of the
34 * empty string.
35 */
36 char *name;
37 char *path;
38 unsigned mode;
39 } *objects;
40 };
41
42 #define OBJECT_ARRAY_INIT { 0, 0, NULL }
43
44 #define TYPE_BITS 3
45 /*
46 * object flag allocation:
47 * revision.h: 0---------10 26
48 * fetch-pack.c: 0----5
49 * walker.c: 0-2
50 * upload-pack.c: 4 11----------------19
51 * builtin/blame.c: 12-13
52 * bisect.c: 16
53 * bundle.c: 16
54 * http-push.c: 16-----19
55 * commit.c: 16-----19
56 * sha1_name.c: 20
57 * list-objects-filter.c: 21
58 * builtin/fsck.c: 0--3
59 * builtin/index-pack.c: 2021
60 * builtin/pack-objects.c: 20
61 * builtin/reflog.c: 10--12
62 * builtin/unpack-objects.c: 2021
63 */
64 #define FLAG_BITS 27
65
66 /*
67 * The object type is stored in 3 bits.
68 */
69 struct object {
70 unsigned parsed : 1;
71 unsigned type : TYPE_BITS;
72 unsigned flags : FLAG_BITS;
73 struct object_id oid;
74 };
75
76 extern const char *type_name(unsigned int type);
77 extern int type_from_string_gently(const char *str, ssize_t, int gentle);
78 #define type_from_string(str) type_from_string_gently(str, -1, 0)
79
80 /*
81 * Return the current number of buckets in the object hashmap.
82 */
83 extern unsigned int get_max_object_index(void);
84
85 /*
86 * Return the object from the specified bucket in the object hashmap.
87 */
88 extern struct object *get_indexed_object(unsigned int);
89
90 /*
91 * This can be used to see if we have heard of the object before, but
92 * it can return "yes we have, and here is a half-initialised object"
93 * for an object that we haven't loaded/parsed yet.
94 *
95 * When parsing a commit to create an in-core commit object, its
96 * parents list holds commit objects that represent its parents, but
97 * they are expected to be lazily initialized and do not know what
98 * their trees or parents are yet. When this function returns such a
99 * half-initialised objects, the caller is expected to initialize them
100 * by calling parse_object() on them.
101 */
102 struct object *lookup_object(const unsigned char *sha1);
103
104 extern void *create_object(struct repository *r, const unsigned char *sha1, void *obj);
105
106 void *object_as_type(struct object *obj, enum object_type type, int quiet);
107
108 /*
109 * Returns the object, having parsed it to find out what it is.
110 *
111 * Returns NULL if the object is missing or corrupt.
112 */
113 struct object *parse_object(const struct object_id *oid);
114
115 /*
116 * Like parse_object, but will die() instead of returning NULL. If the
117 * "name" parameter is not NULL, it is included in the error message
118 * (otherwise, the hex object ID is given).
119 */
120 struct object *parse_object_or_die(const struct object_id *oid, const char *name);
121
122 /* Given the result of read_sha1_file(), returns the object after
123 * parsing it. eaten_p indicates if the object has a borrowed copy
124 * of buffer and the caller should not free() it.
125 */
126 struct object *parse_object_buffer(const struct object_id *oid, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
127
128 /** Returns the object, with potentially excess memory allocated. **/
129 struct object *lookup_unknown_object(const unsigned char *sha1);
130
131 struct object_list *object_list_insert(struct object *item,
132 struct object_list **list_p);
133
134 int object_list_contains(struct object_list *list, struct object *obj);
135
136 /* Object array handling .. */
137 void add_object_array(struct object *obj, const char *name, struct object_array *array);
138 void add_object_array_with_path(struct object *obj, const char *name, struct object_array *array, unsigned mode, const char *path);
139
140 /*
141 * Returns NULL if the array is empty. Otherwise, returns the last object
142 * after removing its entry from the array. Other resources associated
143 * with that object are left in an unspecified state and should not be
144 * examined.
145 */
146 struct object *object_array_pop(struct object_array *array);
147
148 typedef int (*object_array_each_func_t)(struct object_array_entry *, void *);
149
150 /*
151 * Apply want to each entry in array, retaining only the entries for
152 * which the function returns true. Preserve the order of the entries
153 * that are retained.
154 */
155 void object_array_filter(struct object_array *array,
156 object_array_each_func_t want, void *cb_data);
157
158 /*
159 * Remove from array all but the first entry with a given name.
160 * Warning: this function uses an O(N^2) algorithm.
161 */
162 void object_array_remove_duplicates(struct object_array *array);
163
164 /*
165 * Remove any objects from the array, freeing all used memory; afterwards
166 * the array is ready to store more objects with add_object_array().
167 */
168 void object_array_clear(struct object_array *array);
169
170 void clear_object_flags(unsigned flags);
171
172 /*
173 * Clear the specified object flags from all in-core commit objects.
174 */
175 extern void clear_commit_marks_all(unsigned int flags);
176
177 #endif /* OBJECT_H */