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