object.h 6.3 KB
Newer Older
1 2 3
#ifndef OBJECT_H
#define OBJECT_H

4 5
#include "cache.h"

6 7
struct buffer_slab;

8 9 10
struct parsed_object_pool {
	struct object **obj_hash;
	int nr_objs, obj_hash_size;
11 12 13 14 15 16 17 18

	/* TODO: migrate alloc_states to mem-pool? */
	struct alloc_state *blob_state;
	struct alloc_state *tree_state;
	struct alloc_state *commit_state;
	struct alloc_state *tag_state;
	struct alloc_state *object_state;
	unsigned commit_count;
19 20 21 22

	/* parent substitutions from .git/info/grafts and .git/shallow */
	struct commit_graft **grafts;
	int grafts_alloc, grafts_nr;
23 24 25 26

	int is_shallow;
	struct stat_validity *shallow_stat;
	char *alternate_shallow_file;
27 28

	int commit_graft_prepared;
29 30

	struct buffer_slab *buffer_slab;
31 32 33 34 35
};

struct parsed_object_pool *parsed_object_pool_new(void);
void parsed_object_pool_clear(struct parsed_object_pool *o);

36 37 38 39 40
struct object_list {
	struct object *item;
	struct object_list *next;
};

41 42 43 44 45
struct object_array {
	unsigned int nr;
	unsigned int alloc;
	struct object_array_entry {
		struct object *item;
46 47 48 49 50 51 52
		/*
		 * name or NULL.  If non-NULL, the memory pointed to
		 * is owned by this object *except* if it points at
		 * object_array_slopbuf, which is a static copy of the
		 * empty string.
		 */
		char *name;
53
		char *path;
54
		unsigned mode;
55 56 57
	} *objects;
};

58 59
#define OBJECT_ARRAY_INIT { 0, 0, NULL }

60 61
/*
 * object flag allocation:
62
 * revision.h:               0---------10                              25----28
63 64
 * fetch-pack.c:             01
 * negotiator/default.c:       2--5
65
 * walker.c:                 0-2
66
 * upload-pack.c:                4       11-----14  16-----19
67 68 69 70
 * builtin/blame.c:                        12-13
 * bisect.c:                                        16
 * bundle.c:                                        16
 * http-push.c:                                     16-----19
71
 * commit-reach.c:                                15-------19
72
 * sha1-name.c:                                              20
73 74 75 76 77
 * list-objects-filter.c:                                      21
 * builtin/fsck.c:           0--3
 * builtin/index-pack.c:                                     2021
 * builtin/pack-objects.c:                                   20
 * builtin/reflog.c:                   10--12
78
 * builtin/show-branch.c:    0-------------------------------------------26
79
 * builtin/unpack-objects.c:                                 2021
80
 */
81
#define FLAG_BITS  29
82

83 84 85
/*
 * The object type is stored in 3 bits.
 */
86 87
struct object {
	unsigned parsed : 1;
88 89
	unsigned type : TYPE_BITS;
	unsigned flags : FLAG_BITS;
90
	struct object_id oid;
91 92
};

93
extern const char *type_name(unsigned int type);
94 95
extern int type_from_string_gently(const char *str, ssize_t, int gentle);
#define type_from_string(str) type_from_string_gently(str, -1, 0)
96

97 98 99
/*
 * Return the current number of buckets in the object hashmap.
 */
100
extern unsigned int get_max_object_index(void);
101 102 103 104

/*
 * Return the object from the specified bucket in the object hashmap.
 */
105
extern struct object *get_indexed_object(unsigned int);
106

107 108 109 110 111 112 113 114 115 116 117 118
/*
 * This can be used to see if we have heard of the object before, but
 * it can return "yes we have, and here is a half-initialised object"
 * for an object that we haven't loaded/parsed yet.
 *
 * When parsing a commit to create an in-core commit object, its
 * parents list holds commit objects that represent its parents, but
 * they are expected to be lazily initialized and do not know what
 * their trees or parents are yet.  When this function returns such a
 * half-initialised objects, the caller is expected to initialize them
 * by calling parse_object() on them.
 */
119
struct object *lookup_object(struct repository *r, const unsigned char *sha1);
120

121
extern void *create_object(struct repository *r, const unsigned char *sha1, void *obj);
122

123
void *object_as_type(struct repository *r, struct object *obj, enum object_type type, int quiet);
124

125 126 127 128 129
/*
 * Returns the object, having parsed it to find out what it is.
 *
 * Returns NULL if the object is missing or corrupt.
 */
130
struct object *parse_object(struct repository *r, const struct object_id *oid);
131

132 133 134
/*
 * Like parse_object, but will die() instead of returning NULL. If the
 * "name" parameter is not NULL, it is included in the error message
135
 * (otherwise, the hex object ID is given).
136
 */
137
struct object *parse_object_or_die(const struct object_id *oid, const char *name);
138

139 140 141 142
/* Given the result of read_sha1_file(), returns the object after
 * parsing it.  eaten_p indicates if the object has a borrowed copy
 * of buffer and the caller should not free() it.
 */
143
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);
144

145 146 147
/** Returns the object, with potentially excess memory allocated. **/
struct object *lookup_unknown_object(const unsigned  char *sha1);

Junio C Hamano's avatar
Junio C Hamano committed
148
struct object_list *object_list_insert(struct object *item,
149 150 151 152
				       struct object_list **list_p);

int object_list_contains(struct object_list *list, struct object *obj);

153 154
/* Object array handling .. */
void add_object_array(struct object *obj, const char *name, struct object_array *array);
155
void add_object_array_with_path(struct object *obj, const char *name, struct object_array *array, unsigned mode, const char *path);
156

157 158 159 160 161 162 163 164
/*
 * Returns NULL if the array is empty. Otherwise, returns the last object
 * after removing its entry from the array. Other resources associated
 * with that object are left in an unspecified state and should not be
 * examined.
 */
struct object *object_array_pop(struct object_array *array);

165 166 167 168 169 170 171 172 173 174
typedef int (*object_array_each_func_t)(struct object_array_entry *, void *);

/*
 * Apply want to each entry in array, retaining only the entries for
 * which the function returns true.  Preserve the order of the entries
 * that are retained.
 */
void object_array_filter(struct object_array *array,
			 object_array_each_func_t want, void *cb_data);

175 176 177 178 179
/*
 * Remove from array all but the first entry with a given name.
 * Warning: this function uses an O(N^2) algorithm.
 */
void object_array_remove_duplicates(struct object_array *array);
180

181 182 183 184 185 186
/*
 * Remove any objects from the array, freeing all used memory; afterwards
 * the array is ready to store more objects with add_object_array().
 */
void object_array_clear(struct object_array *array);

187 188
void clear_object_flags(unsigned flags);

189 190 191 192 193
/*
 * Clear the specified object flags from all in-core commit objects.
 */
extern void clear_commit_marks_all(unsigned int flags);

194
#endif /* OBJECT_H */