[thirdparty/git.git] / object.h

#ifndef OBJECT_H
#define OBJECT_H

#include "hash.h"

struct buffer_slab;
struct repository;

struct parsed_object_pool {
	struct repository *repo;
	struct object **obj_hash;
	int nr_objs, obj_hash_size;

	/* 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;

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

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

	int commit_graft_prepared;
	int substituted_parent;

	struct buffer_slab *buffer_slab;
};

struct parsed_object_pool *parsed_object_pool_new(struct repository *repo);
void parsed_object_pool_clear(struct parsed_object_pool *o);
void parsed_object_pool_reset_commit_grafts(struct parsed_object_pool *o);

struct object_list {
	struct object *item;
	struct object_list *next;
};

struct object_array {
	unsigned int nr;
	unsigned int alloc;
	struct object_array_entry {
		struct object *item;
		/*
		 * 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;
		char *path;
		unsigned mode;
	} *objects;
};

#define OBJECT_ARRAY_INIT { 0 }

void object_array_init(struct object_array *array);

/*
 * object flag allocation:
 * revision.h:               0---------10         15               23------27
 * fetch-pack.c:             01    67
 * negotiator/default.c:       2--5
 * walker.c:                 0-2
 * upload-pack.c:                4       11-----14  16-----19
 * builtin/blame.c:                        12-13
 * bisect.c:                                        16
 * bundle.c:                                        16
 * http-push.c:                          11-----14
 * commit-graph.c:                                15
 * commit-reach.c:                                  16-----19
 * sha1-name.c:                                              20
 * list-objects-filter.c:                                      21
 * bloom.c:                                                    2122
 * builtin/fsck.c:           0--3
 * builtin/gc.c:             0
 * builtin/index-pack.c:                                     2021
 * reflog.c:                           10--12
 * builtin/show-branch.c:    0-------------------------------------------26
 * builtin/unpack-objects.c:                                 2021
 * pack-bitmap.h:                                              2122
 */
#define FLAG_BITS  28

#define TYPE_BITS 3

/*
 * Values in this enum (except those outside the 3 bit range) are part
 * of pack file format. See gitformat-pack(5) for more information.
 */
enum object_type {
	OBJ_BAD = -1,
	OBJ_NONE = 0,
	OBJ_COMMIT = 1,
	OBJ_TREE = 2,
	OBJ_BLOB = 3,
	OBJ_TAG = 4,
	/* 5 for future expansion */
	OBJ_OFS_DELTA = 6,
	OBJ_REF_DELTA = 7,
	OBJ_ANY,
	OBJ_MAX
};

/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
#define S_IFINVALID     0030000

/*
 * A "directory link" is a link to another git directory.
 *
 * The value 0160000 is not normally a valid mode, and
 * also just happens to be S_IFDIR + S_IFLNK
 */
#define S_IFGITLINK	0160000
#define S_ISGITLINK(m)	(((m) & S_IFMT) == S_IFGITLINK)

#define S_ISSPARSEDIR(m) ((m) == S_IFDIR)

static inline enum object_type object_type(unsigned int mode)
{
	return S_ISDIR(mode) ? OBJ_TREE :
		S_ISGITLINK(mode) ? OBJ_COMMIT :
		OBJ_BLOB;
}

#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
static inline unsigned int create_ce_mode(unsigned int mode)
{
	if (S_ISLNK(mode))
		return S_IFLNK;
	if (S_ISSPARSEDIR(mode))
		return S_IFDIR;
	if (S_ISDIR(mode) || S_ISGITLINK(mode))
		return S_IFGITLINK;
	return S_IFREG | ce_permissions(mode);
}

static inline unsigned int canon_mode(unsigned int mode)
{
	if (S_ISREG(mode))
		return S_IFREG | ce_permissions(mode);
	if (S_ISLNK(mode))
		return S_IFLNK;
	if (S_ISDIR(mode))
		return S_IFDIR;
	return S_IFGITLINK;
}

/*
 * The object type is stored in 3 bits.
 */
struct object {
	unsigned parsed : 1;
	unsigned type : TYPE_BITS;
	unsigned flags : FLAG_BITS;
	struct object_id oid;
};

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

/*
 * Return the current number of buckets in the object hashmap.
 */
unsigned int get_max_object_index(const struct repository *repo);

/*
 * Return the object from the specified bucket in the object hashmap.
 */
struct object *get_indexed_object(const struct repository *repo,
				       unsigned int);

/*
 * 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.
 */
struct object *lookup_object(struct repository *r, const struct object_id *oid);

void *create_object(struct repository *r, const struct object_id *oid, void *obj);

void *object_as_type(struct object *obj, enum object_type type, int quiet);


static inline const char *parse_mode(const char *str, uint16_t *modep)
{
	unsigned char c;
	unsigned int mode = 0;

	if (*str == ' ')
		return NULL;

	while ((c = *str++) != ' ') {
		if (c < '0' || c > '7')
			return NULL;
		mode = (mode << 3) + (c - '0');
	}
	*modep = mode;
	return str;
}

/*
 * Returns the object, having parsed it to find out what it is.
 *
 * Returns NULL if the object is missing or corrupt.
 */
enum parse_object_flags {
	PARSE_OBJECT_SKIP_HASH_CHECK = 1 << 0,
	PARSE_OBJECT_DISCARD_TREE = 1 << 1,
};
struct object *parse_object(struct repository *r, const struct object_id *oid);
struct object *parse_object_with_flags(struct repository *r,
				       const struct object_id *oid,
				       enum parse_object_flags flags);

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

/* 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.
 */
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);

/*
 * Allocate and return an object struct, even if you do not know the type of
 * the object. The returned object may have its "type" field set to a real type
 * (if somebody previously called lookup_blob(), etc), or it may be set to
 * OBJ_NONE. In the latter case, subsequent calls to lookup_blob(), etc, will
 * set the type field as appropriate.
 *
 * Use this when you do not know the expected type of an object and want to
 * avoid parsing it for efficiency reasons. Try to avoid it otherwise; it
 * may allocate excess memory, since the returned object must be as large as
 * the maximum struct of any type.
 */
struct object *lookup_unknown_object(struct repository *r, const struct object_id *oid);

/*
 * Dispatch to the appropriate lookup_blob(), lookup_commit(), etc, based on
 * "type".
 */
struct object *lookup_object_by_type(struct repository *r, const struct object_id *oid,
				     enum object_type type);

enum peel_status {
	/* object was peeled successfully: */
	PEEL_PEELED = 0,

	/*
	 * object cannot be peeled because the named object (or an
	 * object referred to by a tag in the peel chain), does not
	 * exist.
	 */
	PEEL_INVALID = -1,

	/* object cannot be peeled because it is not a tag: */
	PEEL_NON_TAG = -2,

	/* ref_entry contains no peeled value because it is a symref: */
	PEEL_IS_SYMREF = -3,

	/*
	 * ref_entry cannot be peeled because it is broken (i.e., the
	 * symbolic reference cannot even be resolved to an object
	 * name):
	 */
	PEEL_BROKEN = -4
};

/*
 * Peel the named object; i.e., if the object is a tag, resolve the
 * tag recursively until a non-tag is found.  If successful, store the
 * result to oid and return PEEL_PEELED.  If the object is not a tag
 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
 * and leave oid unchanged.
 */
enum peel_status peel_object(struct repository *r,
			     const struct object_id *name, struct object_id *oid);

struct object_list *object_list_insert(struct object *item,
				       struct object_list **list_p);

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

void object_list_free(struct object_list **list);

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

/*
 * 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);

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);

/*
 * 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);

void clear_object_flags(struct repository *repo, unsigned flags);

/*
 * Clear the specified object flags from all in-core commit objects from
 * the specified repository.
 */
void repo_clear_commit_marks(struct repository *r, unsigned int flags);

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