blob: 9bd8c2d06c80c958b5f654fe16e7294883e49a30 [file] [log] [blame]
Linus Torvaldse83c5162005-04-07 15:13:13 -07001#ifndef CACHE_H
2#define CACHE_H
3
Junio C Hamano4050c0d2005-12-05 11:54:29 -08004#include "git-compat-util.h"
Pierre Habouzit5ecd2932007-09-16 15:51:04 +02005#include "strbuf.h"
Linus Torvaldscf558702008-01-22 18:41:14 -08006#include "hash.h"
Jeff King75194432009-09-09 07:38:58 -04007#include "advice.h"
Ævar Arnfjörð Bjarmason65784832011-02-22 23:41:20 +00008#include "gettext.h"
Junio C Hamanod1bf0e02011-05-20 12:59:01 -07009#include "convert.h"
Linus Torvaldse83c5162005-04-07 15:13:13 -070010
Linus Torvaldscef661f2005-04-21 12:33:22 -070011#include SHA1_HEADER
Nicolas Pitre9126f002008-10-01 14:05:20 -040012#ifndef git_SHA_CTX
13#define git_SHA_CTX SHA_CTX
14#define git_SHA1_Init SHA1_Init
15#define git_SHA1_Update SHA1_Update
16#define git_SHA1_Final SHA1_Final
17#endif
Linus Torvaldse83c5162005-04-07 15:13:13 -070018
Nicolas Pitre9126f002008-10-01 14:05:20 -040019#include <zlib.h>
Junio C Hamanoef49a7a2011-06-10 11:52:15 -070020typedef struct git_zstream {
21 z_stream z;
22 unsigned long avail_in;
23 unsigned long avail_out;
24 unsigned long total_in;
25 unsigned long total_out;
26 unsigned char *next_in;
27 unsigned char *next_out;
28} git_zstream;
Edgar Toernig9da3acf2005-04-30 09:51:03 -070029
Junio C Hamanoef49a7a2011-06-10 11:52:15 -070030void git_inflate_init(git_zstream *);
31void git_inflate_init_gzip_only(git_zstream *);
32void git_inflate_end(git_zstream *);
33int git_inflate(git_zstream *, int flush);
Linus Torvalds39c68542009-01-07 19:54:47 -080034
Junio C Hamanoef49a7a2011-06-10 11:52:15 -070035void git_deflate_init(git_zstream *, int level);
36void git_deflate_init_gzip(git_zstream *, int level);
37void git_deflate_end(git_zstream *);
Junio C Hamano568508e2011-10-28 14:48:40 -070038int git_deflate_abort(git_zstream *);
Junio C Hamanoef49a7a2011-06-10 11:52:15 -070039int git_deflate_end_gently(git_zstream *);
40int git_deflate(git_zstream *, int flush);
41unsigned long git_deflate_bound(git_zstream *, unsigned long);
Junio C Hamano0bdd79a2006-01-20 13:33:20 -080042
43#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
44#define DTYPE(de) ((de)->d_type)
45#else
Edgar Toernigb6829692005-04-30 09:51:03 -070046#undef DT_UNKNOWN
47#undef DT_DIR
48#undef DT_REG
Junio C Hamanoa15c1c62005-05-12 17:16:04 -070049#undef DT_LNK
Edgar Toernigb6829692005-04-30 09:51:03 -070050#define DT_UNKNOWN 0
51#define DT_DIR 1
52#define DT_REG 2
Martin Koegler40689ae2007-04-22 18:43:56 +020053#define DT_LNK 3
54#define DTYPE(de) DT_UNKNOWN
55#endif
Linus Torvaldse83c5162005-04-07 15:13:13 -070056
Linus Torvalds9eec4792007-04-09 21:14:58 -070057/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
58#define S_IFINVALID 0030000
59
60/*
61 * A "directory link" is a link to another git directory.
62 *
63 * The value 0160000 is not normally a valid mode, and
64 * also just happens to be S_IFDIR + S_IFLNK
65 *
66 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
67 * always having the same values everywhere. We should use
68 * our internal git values for these things, and then we can
Martin Waitz302b9282007-05-21 22:08:28 +020069 * translate that to the OS-specific value. It just so
70 * happens that everybody shares the same bit representation
Linus Torvalds9eec4792007-04-09 21:14:58 -070071 * in the UNIX world (and apparently wider too..)
72 */
Linus Torvalds2386d652005-07-13 18:46:20 -070073#define S_IFGITLINK 0160000
74#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
75
76/*
77 * Intensive research over the course of many years has shown that
78 * port 9418 is totally unused by anything else. Or
Linus Torvaldsba8a4972005-09-12 11:23:00 -070079 *
80 * Your search - "port 9418" - did not match any documents.
81 *
82 * as www.google.com puts it.
83 *
84 * This port has been properly assigned for git use by IANA:
85 * git (Assigned-9418) [I06-050728-0001].
86 *
87 * git 9418/tcp git pack transfer service
88 * git 9418/udp git pack transfer service
89 *
Linus Torvalds2386d652005-07-13 18:46:20 -070090 * with Linus Torvalds <torvalds@osdl.org> as the point of
91 * contact. September 2005.
92 *
93 * See http://www.iana.org/assignments/port-numbers
Linus Torvaldse83c5162005-04-07 15:13:13 -070094 */
Linus Torvaldse83c5162005-04-07 15:13:13 -070095#define DEFAULT_GIT_PORT 9418
96
97/*
98 * Basic data structures for the directory cache
Linus Torvaldsccc4feb2005-04-15 10:44:27 -070099 */
100
101#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
Linus Torvaldse83c5162005-04-07 15:13:13 -0700102struct cache_header {
103 unsigned int hdr_signature;
104 unsigned int hdr_version;
105 unsigned int hdr_entries;
106};
107
108/*
109 * The "cache_time" is just the low 32 bits of the
110 * time. It doesn't matter if it overflows - we only
111 * check it for equality in the 32 bits we save.
112 */
113struct cache_time {
114 unsigned int sec;
115 unsigned int nsec;
116};
117
Linus Torvaldsccc4feb2005-04-15 10:44:27 -0700118/*
119 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
120 * Again - this is just a (very strong in practice) heuristic that
Linus Torvaldse83c5162005-04-07 15:13:13 -0700121 * the inode hasn't changed.
Linus Torvalds7a51ed62008-01-14 16:03:17 -0800122 *
123 * We save the fields in big-endian order to allow using the
124 * index file over NFS transparently.
125 */
126struct ondisk_cache_entry {
127 struct cache_time ctime;
128 struct cache_time mtime;
129 unsigned int dev;
130 unsigned int ino;
131 unsigned int mode;
132 unsigned int uid;
133 unsigned int gid;
134 unsigned int size;
135 unsigned char sha1[20];
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 11:04:01 +0700136 unsigned short flags;
137 char name[FLEX_ARRAY]; /* more */
138};
139
140/*
141 * This struct is used when CE_EXTENDED bit is 1
142 * The struct must match ondisk_cache_entry exactly from
143 * ctime till flags
144 */
145struct ondisk_cache_entry_extended {
146 struct cache_time ctime;
147 struct cache_time mtime;
148 unsigned int dev;
149 unsigned int ino;
150 unsigned int mode;
151 unsigned int uid;
152 unsigned int gid;
153 unsigned int size;
154 unsigned char sha1[20];
155 unsigned short flags;
Linus Torvaldse83c5162005-04-07 15:13:13 -0700156 unsigned short flags2;
Linus Torvalds7a51ed62008-01-14 16:03:17 -0800157 char name[FLEX_ARRAY]; /* more */
158};
Linus Torvaldsccc4feb2005-04-15 10:44:27 -0700159
160struct cache_entry {
Kjetil Barvikfba2f382009-02-19 21:08:29 +0100161 struct cache_time ce_ctime;
162 struct cache_time ce_mtime;
Linus Torvaldsccc4feb2005-04-15 10:44:27 -0700163 unsigned int ce_dev;
164 unsigned int ce_ino;
165 unsigned int ce_mode;
166 unsigned int ce_uid;
167 unsigned int ce_gid;
168 unsigned int ce_size;
Linus Torvalds7a51ed62008-01-14 16:03:17 -0800169 unsigned int ce_flags;
Linus Torvaldse83c5162005-04-07 15:13:13 -0700170 unsigned char sha1[20];
Linus Torvaldseb7a2f12008-02-22 20:41:17 -0800171 struct cache_entry *next;
Jeff King25481832011-10-06 12:06:09 -0400172 struct cache_entry *dir_next;
Junio C Hamano8f1d2e62006-01-07 01:33:54 -0800173 char name[FLEX_ARRAY]; /* more */
Linus Torvaldse83c5162005-04-07 15:13:13 -0700174};
175
Linus Torvalds95fd5bf2005-04-15 22:51:44 -0700176#define CE_NAMEMASK (0x0fff)
177#define CE_STAGEMASK (0x3000)
Junio C Hamano16ce2e42008-08-16 23:02:08 -0700178#define CE_EXTENDED (0x4000)
Junio C Hamano5f730762006-02-08 21:15:24 -0800179#define CE_VALID (0x8000)
Junio C Hamanoaee46192005-04-16 08:33:23 -0700180#define CE_STAGESHIFT 12
Linus Torvalds95fd5bf2005-04-15 22:51:44 -0700181
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 11:04:01 +0700182/*
183 * Range 0xFFFF0000 in ce_flags is divided into
184 * two parts: in-memory flags and on-disk ones.
185 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
186 * if you want to save a new flag, add it in
187 * CE_EXTENDED_FLAGS
188 *
189 * In-memory only flags
190 */
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 13:22:16 +0700191#define CE_UPDATE (1 << 16)
192#define CE_REMOVE (1 << 17)
193#define CE_UPTODATE (1 << 18)
194#define CE_ADDED (1 << 19)
Linus Torvaldsa22c6372008-02-22 20:37:40 -0800195
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 13:22:16 +0700196#define CE_HASHED (1 << 20)
197#define CE_UNHASHED (1 << 21)
198#define CE_WT_REMOVE (1 << 22) /* remove in work directory */
199#define CE_CONFLICTED (1 << 23)
Linus Torvalds7a51ed62008-01-14 16:03:17 -0800200
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 13:22:16 +0700201#define CE_UNPACKED (1 << 24)
Nguyễn Thái Ngọc Duy2431afb2010-11-27 13:24:04 +0700202#define CE_NEW_SKIP_WORKTREE (1 << 25)
Junio C Hamanoda165f42010-01-07 14:59:54 -0800203
Linus Torvaldsd070e3a2008-02-22 20:39:21 -0800204/*
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 11:04:01 +0700205 * Extended on-disk flags
206 */
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 13:22:16 +0700207#define CE_INTENT_TO_ADD (1 << 29)
208#define CE_SKIP_WORKTREE (1 << 30)
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 11:04:01 +0700209/* CE_EXTENDED2 is for future extension */
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 13:22:16 +0700210#define CE_EXTENDED2 (1 << 31)
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 11:04:01 +0700211
Nguyễn Thái Ngọc Duy44a36912009-08-20 20:46:57 +0700212#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 11:04:01 +0700213
214/*
215 * Safeguard to avoid saving wrong flags:
216 * - CE_EXTENDED2 won't get saved until its semantic is known
217 * - Bits in 0x0000FFFF have been saved in ce_flags already
218 * - Bits in 0x003F0000 are currently in-memory flags
219 */
220#if CE_EXTENDED_FLAGS & 0x803FFFFF
221#error "CE_EXTENDED_FLAGS out of range"
222#endif
223
224/*
Linus Torvaldseb7a2f12008-02-22 20:41:17 -0800225 * Copy the sha1 and stat state of a cache entry from one to
226 * another. But we never change the name, or the hash state!
227 */
228#define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
229static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
230{
231 unsigned int state = dst->ce_flags & CE_STATE_MASK;
232
233 /* Don't copy hash chain and name */
234 memcpy(dst, src, offsetof(struct cache_entry, next));
235
236 /* Restore the hash state */
237 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
238}
239
Junio C Hamano7fec10b2008-01-18 23:42:00 -0800240static inline unsigned create_ce_flags(size_t len, unsigned stage)
241{
242 if (len >= CE_NAMEMASK)
243 len = CE_NAMEMASK;
244 return (len | (stage << CE_STAGESHIFT));
245}
246
247static inline size_t ce_namelen(const struct cache_entry *ce)
248{
249 size_t len = ce->ce_flags & CE_NAMEMASK;
250 if (len < CE_NAMEMASK)
251 return len;
252 return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
253}
254
Junio C Hamanoaee46192005-04-16 08:33:23 -0700255#define ce_size(ce) cache_entry_size(ce_namelen(ce))
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 11:04:01 +0700256#define ondisk_ce_size(ce) (((ce)->ce_flags & CE_EXTENDED) ? \
257 ondisk_cache_entry_extended_size(ce_namelen(ce)) : \
258 ondisk_cache_entry_size(ce_namelen(ce)))
Linus Torvalds7a51ed62008-01-14 16:03:17 -0800259#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
Junio C Hamanoeadb5832008-01-18 23:45:24 -0800260#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
Nguyễn Thái Ngọc Duy44a36912009-08-20 20:46:57 +0700261#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
Junio C Hamanoeadb5832008-01-18 23:45:24 -0800262#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
Junio C Hamanoaee46192005-04-16 08:33:23 -0700263
Linus Torvaldse4479472005-04-16 22:26:31 -0700264#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
Kay Sievers8ae0a8c2005-05-05 14:38:25 +0200265static inline unsigned int create_ce_mode(unsigned int mode)
266{
Kay Sievers8ae0a8c2005-05-05 14:38:25 +0200267 if (S_ISLNK(mode))
Linus Torvalds7a51ed62008-01-14 16:03:17 -0800268 return S_IFLNK;
Martin Waitz302b9282007-05-21 22:08:28 +0200269 if (S_ISDIR(mode) || S_ISGITLINK(mode))
Linus Torvalds7a51ed62008-01-14 16:03:17 -0800270 return S_IFGITLINK;
271 return S_IFREG | ce_permissions(mode);
Kay Sievers8ae0a8c2005-05-05 14:38:25 +0200272}
Junio C Hamano185c9752007-02-16 22:43:48 -0800273static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
274{
Johannes Sixt78a8d642007-03-02 22:11:30 +0100275 extern int trust_executable_bit, has_symlinks;
276 if (!has_symlinks && S_ISREG(mode) &&
Linus Torvalds7a51ed62008-01-14 16:03:17 -0800277 ce && S_ISLNK(ce->ce_mode))
Johannes Sixt78a8d642007-03-02 22:11:30 +0100278 return ce->ce_mode;
Junio C Hamano185c9752007-02-16 22:43:48 -0800279 if (!trust_executable_bit && S_ISREG(mode)) {
Linus Torvalds7a51ed62008-01-14 16:03:17 -0800280 if (ce && S_ISREG(ce->ce_mode))
Junio C Hamano185c9752007-02-16 22:43:48 -0800281 return ce->ce_mode;
282 return create_ce_mode(0666);
283 }
284 return create_ce_mode(mode);
285}
Junio C Hamanod6b8fc32008-01-31 01:17:48 -0800286static inline int ce_to_dtype(const struct cache_entry *ce)
287{
288 unsigned ce_mode = ntohl(ce->ce_mode);
289 if (S_ISREG(ce_mode))
290 return DT_REG;
291 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
292 return DT_DIR;
293 else if (S_ISLNK(ce_mode))
294 return DT_LNK;
295 else
296 return DT_UNKNOWN;
297}
René Scharfeb90d9b82010-10-04 12:53:11 +0200298static inline unsigned int canon_mode(unsigned int mode)
299{
300 if (S_ISREG(mode))
301 return S_IFREG | ce_permissions(mode);
302 if (S_ISLNK(mode))
303 return S_IFLNK;
304 if (S_ISDIR(mode))
305 return S_IFDIR;
306 return S_IFGITLINK;
307}
Linus Torvaldse4479472005-04-16 22:26:31 -0700308
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 11:04:01 +0700309#define flexible_size(STRUCT,len) ((offsetof(struct STRUCT,name) + (len) + 8) & ~7)
René Scharfeee7825b2011-10-25 20:00:04 +0200310#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 11:04:01 +0700311#define ondisk_cache_entry_size(len) flexible_size(ondisk_cache_entry,len)
312#define ondisk_cache_entry_extended_size(len) flexible_size(ondisk_cache_entry_extended,len)
Linus Torvaldsf5cabd12005-04-15 21:45:38 -0700313
Junio C Hamano228e94f2007-04-01 18:14:06 -0700314struct index_state {
315 struct cache_entry **cache;
316 unsigned int cache_nr, cache_alloc, cache_changed;
Junio C Hamanocfc57892009-12-25 00:30:51 -0800317 struct string_list *resolve_undo;
Junio C Hamano228e94f2007-04-01 18:14:06 -0700318 struct cache_tree *cache_tree;
Kjetil Barvikfba2f382009-02-19 21:08:29 +0100319 struct cache_time timestamp;
Junio C Hamano913e0e92008-08-23 12:57:30 -0700320 unsigned name_hash_initialized : 1,
321 initialized : 1;
Linus Torvaldscf558702008-01-22 18:41:14 -0800322 struct hash_table name_hash;
Junio C Hamano228e94f2007-04-01 18:14:06 -0700323};
324
325extern struct index_state the_index;
326
Linus Torvalds96872bc2008-03-21 13:16:24 -0700327/* Name hashing */
328extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
329/*
330 * We don't actually *remove* it, we can just mark it invalid so that
331 * we won't find it in lookups.
332 *
333 * Not only would we have to search the lists (simple enough), but
334 * we'd also have to rehash other hash buckets in case this makes the
335 * hash bucket empty (common). So it's much better to just mark
336 * it.
337 */
338static inline void remove_name_hash(struct cache_entry *ce)
339{
340 ce->ce_flags |= CE_UNHASHED;
341}
342
343
Junio C Hamano4aab5b42007-04-01 23:26:07 -0700344#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
Junio C Hamano228e94f2007-04-01 18:14:06 -0700345#define active_cache (the_index.cache)
346#define active_nr (the_index.cache_nr)
347#define active_alloc (the_index.cache_alloc)
348#define active_cache_changed (the_index.cache_changed)
349#define active_cache_tree (the_index.cache_tree)
Linus Torvaldse83c5162005-04-07 15:13:13 -0700350
Junio C Hamano4aab5b42007-04-01 23:26:07 -0700351#define read_cache() read_index(&the_index)
352#define read_cache_from(path) read_index_from(&the_index, (path))
Linus Torvalds671c9b72008-11-13 16:36:30 -0800353#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
Junio C Hamanofa7b3c22008-11-12 11:52:35 -0800354#define is_cache_unborn() is_index_unborn(&the_index)
Miklos Vajnae46bbcf2008-06-27 18:21:58 +0200355#define read_cache_unmerged() read_index_unmerged(&the_index)
Junio C Hamano4aab5b42007-04-01 23:26:07 -0700356#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
357#define discard_cache() discard_index(&the_index)
Daniel Barkalow94a57282008-02-07 11:40:13 -0500358#define unmerged_cache() unmerged_index(&the_index)
Junio C Hamano4aab5b42007-04-01 23:26:07 -0700359#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
360#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
Petr Baudis81dc2302008-07-21 02:25:56 +0200361#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
Junio C Hamano4aab5b42007-04-01 23:26:07 -0700362#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
363#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
Junio C Hamano38ed1d82008-05-21 12:04:34 -0700364#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
365#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
Matthieu Moy3deffc52009-08-21 10:57:59 +0200366#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
Junio C Hamano4bd5b7d2007-11-10 00:15:03 -0800367#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
368#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
Linus Torvaldscd2fef52008-03-21 15:55:19 -0700369#define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
Jeff King98fa4732008-10-16 11:07:26 -0400370#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
Junio C Hamanocfc57892009-12-25 00:30:51 -0800371#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
Junio C Hamano8aa38562009-12-25 13:40:02 -0800372#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
Junio C Hamano4421a822009-12-25 11:57:11 -0800373#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
Junio C Hamano4aab5b42007-04-01 23:26:07 -0700374#endif
Linus Torvaldse83c5162005-04-07 15:13:13 -0700375
Junio C Hamanoedaec3f2007-02-28 11:45:56 -0800376enum object_type {
377 OBJ_BAD = -1,
378 OBJ_NONE = 0,
379 OBJ_COMMIT = 1,
380 OBJ_TREE = 2,
381 OBJ_BLOB = 3,
382 OBJ_TAG = 4,
383 /* 5 for future expansion */
384 OBJ_OFS_DELTA = 6,
385 OBJ_REF_DELTA = 7,
Martin Koegler355885d2008-02-25 22:46:04 +0100386 OBJ_ANY,
Gary V. Vaughan4b055482010-05-14 09:31:35 +0000387 OBJ_MAX
Junio C Hamanoedaec3f2007-02-28 11:45:56 -0800388};
389
Junio C Hamanob45563a2007-11-30 22:22:38 -0800390static inline enum object_type object_type(unsigned int mode)
391{
392 return S_ISDIR(mode) ? OBJ_TREE :
393 S_ISGITLINK(mode) ? OBJ_COMMIT :
394 OBJ_BLOB;
395}
396
Junio C Hamano8ac069a2005-05-09 22:57:58 -0700397#define GIT_DIR_ENVIRONMENT "GIT_DIR"
Josh Tripletta1bea2c2011-07-05 10:54:44 -0700398#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
Matthias Lederhofer892c41b2007-06-06 09:10:42 +0200399#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
Junio C Hamano8ac069a2005-05-09 22:57:58 -0700400#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
Junio C Hamanod19938a2005-05-09 17:57:56 -0700401#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
Linus Torvaldsbb233d62005-04-21 10:55:18 -0700402#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
Junio C Hamano5da5c8f2005-07-30 00:58:28 -0700403#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
Junio C Hamanod4ebc362006-12-19 01:28:15 -0800404#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
405#define CONFIG_ENVIRONMENT "GIT_CONFIG"
Jeff King2b64fc82010-08-23 15:16:00 -0400406#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
Junio C Hamanod4ebc362006-12-19 01:28:15 -0800407#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
David Reiss0454dd92008-05-19 23:49:26 -0700408#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
Christian Couder6476b382009-11-18 07:50:58 +0100409#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
Junio C Hamanod0bfd022007-04-12 01:07:32 -0700410#define GITATTRIBUTES_FILE ".gitattributes"
411#define INFOATTRIBUTES_FILE "info/attributes"
Junio C Hamanof48fd682007-04-14 08:54:37 -0700412#define ATTRIBUTE_MACRO_PREFIX "[attr]"
Johannes Schindelina97a7462009-10-09 12:21:57 +0200413#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
414#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
Thomas Rast894a9d32010-03-12 18:04:26 +0100415#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
Thomas Rast6956f852010-03-12 18:04:32 +0100416#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
417#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
Linus Torvaldsbb233d62005-04-21 10:55:18 -0700418
Giuseppe Bilotta48a7c1c2010-02-25 00:34:14 +0100419/*
420 * Repository-local GIT_* environment variables
421 * The array is NULL-terminated to simplify its usage in contexts such
422 * environment creation or simple walk of the list.
423 * The number of non-NULL entries is available as a macro.
424 */
Jonathan Nieder655e8d92010-08-24 01:41:14 -0500425#define LOCAL_REPO_ENV_SIZE 9
Giuseppe Bilotta48a7c1c2010-02-25 00:34:14 +0100426extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];
427
Junio C Hamano7d1864c2007-01-07 02:00:28 -0800428extern int is_bare_repository_cfg;
429extern int is_bare_repository(void);
Johannes Schindelin68025632007-01-20 03:09:34 +0100430extern int is_inside_git_dir(void);
Johannes Schindeline90fdc32007-08-01 01:30:14 +0100431extern char *git_work_tree_cfg;
Matthias Lederhofer892c41b2007-06-06 09:10:42 +0200432extern int is_inside_work_tree(void);
Dmitry Potapovd2b07082008-09-27 12:41:50 +0400433extern int have_git_dir(void);
Pierre Habouzitc5fba162006-08-23 12:39:11 +0200434extern const char *get_git_dir(void);
Junio C Hamano8ac069a2005-05-09 22:57:58 -0700435extern char *get_object_directory(void);
436extern char *get_index_file(void);
Junio C Hamano5da5c8f2005-07-30 00:58:28 -0700437extern char *get_graft_file(void);
Johannes Schindelind7ac12b2007-08-01 01:29:38 +0100438extern int set_git_dir(const char *path);
Josh Tripletta1bea2c2011-07-05 10:54:44 -0700439extern const char *get_git_namespace(void);
440extern const char *strip_namespace(const char *namespaced_ref);
Johannes Schindeline90fdc32007-08-01 01:30:14 +0100441extern const char *get_git_work_tree(void);
Junio C Hamano13d6ec92011-08-22 14:04:56 -0700442extern const char *read_gitfile(const char *path);
Fredrik Gustafssonabc06822011-08-15 23:17:46 +0200443extern const char *resolve_gitdir(const char *suspect);
Daniel Barkalow19757d82008-04-27 13:39:21 -0400444extern void set_git_work_tree(const char *tree);
Junio C Hamano8ac069a2005-05-09 22:57:58 -0700445
446#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
Linus Torvaldsbb233d62005-04-21 10:55:18 -0700447
Junio C Hamano6b5ee132005-09-21 00:00:47 -0700448extern const char **get_pathspec(const char *prefix, const char **pathspec);
Mike Hommey59f0f2f2007-11-03 12:23:11 +0100449extern void setup_work_tree(void);
Junio C Hamano4ca06602005-11-25 23:14:15 -0800450extern const char *setup_git_directory_gently(int *);
Linus Torvaldsd288a702005-08-16 18:06:34 -0700451extern const char *setup_git_directory(void);
Nguyễn Thái Ngọc Duyedc54fb2010-11-11 21:08:03 +0700452extern char *prefix_path(const char *prefix, int len, const char *path);
Junio C Hamano4ca06602005-11-25 23:14:15 -0800453extern const char *prefix_filename(const char *prefix, int len, const char *path);
Junio C Hamanoc6e8c802009-10-18 00:27:24 -0700454extern int check_filename(const char *prefix, const char *name);
Linus Torvaldse23d0b42006-04-26 10:15:54 -0700455extern void verify_filename(const char *prefix, const char *name);
Junio C Hamanoea92f412006-04-26 15:09:27 -0700456extern void verify_non_filename(const char *prefix, const char *name);
Linus Torvaldsd288a702005-08-16 18:06:34 -0700457
Daniel Barkalowf225aeb2008-04-27 13:39:27 -0400458#define INIT_DB_QUIET 0x0001
459
Nguyễn Thái Ngọc Duyb57fb802011-03-19 22:16:56 +0700460extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
Daniel Barkalowf225aeb2008-04-27 13:39:27 -0400461extern int init_db(const char *template_dir, unsigned int flags);
462
Linus Torvaldse83c5162005-04-07 15:13:13 -0700463#define alloc_nr(x) (((x)+16)*3/2)
464
Jeff King6815e562007-06-11 09:39:44 -0400465/*
466 * Realloc the buffer pointed at by variable 'x' so that it can hold
467 * at least 'nr' entries; the number of entries currently allocated
468 * is 'alloc', using the standard growing factor alloc_nr() macro.
469 *
Jonathan Nieder01f6fd42010-10-08 11:46:59 -0500470 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
Jeff King6815e562007-06-11 09:39:44 -0400471 */
472#define ALLOC_GROW(x, nr, alloc) \
473 do { \
Jeff Kingc927e6c2007-06-16 18:37:39 -0400474 if ((nr) > alloc) { \
Junio C Hamano4234a762007-06-11 22:10:55 -0700475 if (alloc_nr(alloc) < (nr)) \
476 alloc = (nr); \
477 else \
478 alloc = alloc_nr(alloc); \
Jeff King6815e562007-06-11 09:39:44 -0400479 x = xrealloc((x), alloc * sizeof(*(x))); \
480 } \
Jonathan Nieder98746062010-08-12 17:11:15 -0500481 } while (0)
Jeff King6815e562007-06-11 09:39:44 -0400482
Linus Torvalds734aab72005-04-09 09:48:20 -0700483/* Initialize and use the cache information */
Junio C Hamano4aab5b42007-04-01 23:26:07 -0700484extern int read_index(struct index_state *);
Linus Torvalds671c9b72008-11-13 16:36:30 -0800485extern int read_index_preload(struct index_state *, const char **pathspec);
Junio C Hamano4aab5b42007-04-01 23:26:07 -0700486extern int read_index_from(struct index_state *, const char *path);
Junio C Hamanofa7b3c22008-11-12 11:52:35 -0800487extern int is_index_unborn(struct index_state *);
Miklos Vajnae46bbcf2008-06-27 18:21:58 +0200488extern int read_index_unmerged(struct index_state *);
Kjetil Barvike1afca42009-02-23 19:02:57 +0100489extern int write_index(struct index_state *, int newfd);
Junio C Hamano4aab5b42007-04-01 23:26:07 -0700490extern int discard_index(struct index_state *);
Linus Torvaldsd1f128b2008-03-06 12:46:09 -0800491extern int unmerged_index(const struct index_state *);
Linus Torvalds8dcf39c2006-05-18 12:07:31 -0700492extern int verify_path(const char *path);
Linus Torvaldscd2fef52008-03-21 15:55:19 -0700493extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
Linus Torvaldsd1f128b2008-03-06 12:46:09 -0800494extern int index_name_pos(const struct index_state *, const char *name, int namelen);
Junio C Hamano192268c2005-05-07 21:55:21 -0700495#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
496#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
Junio C Hamanob1557252005-06-25 02:25:29 -0700497#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
Junio C Hamanoaf3785d2007-08-09 13:42:50 -0700498#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
Junio C Hamano39425812008-08-21 01:44:53 -0700499#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
Junio C Hamano4aab5b42007-04-01 23:26:07 -0700500extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
Petr Baudis81dc2302008-07-21 02:25:56 +0200501extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
Junio C Hamano4aab5b42007-04-01 23:26:07 -0700502extern int remove_index_entry_at(struct index_state *, int pos);
Kjetil Barvik36419c82009-02-18 23:18:03 +0100503extern void remove_marked_cache_entries(struct index_state *istate);
Junio C Hamano4aab5b42007-04-01 23:26:07 -0700504extern int remove_file_from_index(struct index_state *, const char *path);
Junio C Hamano38ed1d82008-05-21 12:04:34 -0700505#define ADD_CACHE_VERBOSE 1
506#define ADD_CACHE_PRETEND 2
Junio C Hamano01665922008-05-25 14:03:50 -0700507#define ADD_CACHE_IGNORE_ERRORS 4
Junio C Hamano041aee32008-07-21 01:24:17 -0700508#define ADD_CACHE_IGNORE_REMOVAL 8
Junio C Hamano39425812008-08-21 01:44:53 -0700509#define ADD_CACHE_INTENT 16
Junio C Hamano38ed1d82008-05-21 12:04:34 -0700510extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
511extern int add_file_to_index(struct index_state *, const char *path, int flags);
Carlos Rica6640f882007-09-11 05:17:28 +0200512extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
Brad Robertsdbbce552005-05-14 19:04:25 -0700513extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
Jeff King98fa4732008-10-16 11:07:26 -0400514extern int index_name_is_other(const struct index_state *, const char *, int);
Junio C Hamano4bd5b7d2007-11-10 00:15:03 -0800515
516/* do stat comparison even if CE_VALID is true */
517#define CE_MATCH_IGNORE_VALID 01
518/* do not check the contents but report dirty on racily-clean entries */
Nguyễn Thái Ngọc Duy56cac482009-12-14 18:43:58 +0700519#define CE_MATCH_RACY_IS_DIRTY 02
520/* do stat comparison even if CE_SKIP_WORKTREE is true */
521#define CE_MATCH_IGNORE_SKIP_WORKTREE 04
Linus Torvaldsd1f128b2008-03-06 12:46:09 -0800522extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
523extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
Junio C Hamano4bd5b7d2007-11-10 00:15:03 -0800524
Nguyễn Thái Ngọc Duy0602f3e2010-12-15 22:02:36 +0700525struct pathspec {
526 const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
527 int nr;
Jonathan Nieder9ddf1722011-03-15 22:42:32 -0500528 unsigned int has_wildcard:1;
529 unsigned int recursive:1;
Nguyễn Thái Ngọc Duybc96cc82010-12-15 22:02:44 +0700530 int max_depth;
Nguyễn Thái Ngọc Duy0602f3e2010-12-15 22:02:36 +0700531 struct pathspec_item {
532 const char *match;
533 int len;
Junio C Hamano33e0f622011-04-05 09:30:36 -0700534 unsigned int use_wildcard:1;
Nguyễn Thái Ngọc Duy0602f3e2010-12-15 22:02:36 +0700535 } *items;
536};
537
538extern int init_pathspec(struct pathspec *, const char **);
539extern void free_pathspec(struct pathspec *);
Nguyễn Thái Ngọc Duyeb9cb552010-12-17 19:43:07 +0700540extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
Junio C Hamanoc4ce46f2011-05-08 01:47:33 -0700541
542#define HASH_WRITE_OBJECT 1
543#define HASH_FORMAT_CHECK 2
544extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
545extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
Junio C Hamano415e96c2005-05-15 14:23:12 -0700546extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
547
Linus Torvalds405e5b22006-05-19 09:56:35 -0700548#define REFRESH_REALLY 0x0001 /* ignore_valid */
549#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
550#define REFRESH_QUIET 0x0004 /* be quiet about it */
551#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
Junio C Hamano3f1b7b62008-07-19 23:25:00 -0700552#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
Matthieu Moy43673fd2009-08-21 10:57:58 +0200553#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
Jonathan Nieder046613c2011-02-22 22:43:23 +0000554extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, const char *header_msg);
Linus Torvalds405e5b22006-05-19 09:56:35 -0700555
Junio C Hamano021b6e42006-06-06 12:51:49 -0700556struct lock_file {
557 struct lock_file *next;
Johannes Schindelin4723ee92007-11-13 21:05:03 +0100558 int fd;
Junio C Hamano5e635e32007-04-21 03:11:10 -0700559 pid_t owner;
Junio C Hamano1084b842007-01-02 11:19:05 -0800560 char on_list;
Junio C Hamano021b6e42006-06-06 12:51:49 -0700561 char filename[PATH_MAX];
Junio C Hamano415e96c2005-05-15 14:23:12 -0700562};
Junio C Hamanoacd3b9e2008-10-17 15:44:39 -0700563#define LOCK_DIE_ON_ERROR 1
564#define LOCK_NODEREF 2
Miklos Vajna1b018fd2009-09-27 01:15:09 +0200565extern int unable_to_lock_error(const char *path, int err);
Matthieu Moye43a6fd2009-02-19 13:54:18 +0100566extern NORETURN void unable_to_lock_index_die(const char *path, int err);
Junio C Hamano40aaae82006-08-12 01:03:47 -0700567extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
Daniel Barkalowea3cd5c2008-04-17 19:32:26 -0400568extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
Junio C Hamano021b6e42006-06-06 12:51:49 -0700569extern int commit_lock_file(struct lock_file *);
Junio C Hamanoccdc4ec2011-03-21 10:16:10 -0700570extern void update_index_if_able(struct index_state *, struct lock_file *);
Junio C Hamano30ca07a2007-03-31 23:09:02 -0700571
572extern int hold_locked_index(struct lock_file *, int);
573extern int commit_locked_index(struct lock_file *);
Junio C Hamano5e7f56a2007-03-31 23:27:41 -0700574extern void set_alternate_index_output(const char *);
Brandon Caseyd6cf61b2008-01-16 11:05:32 -0800575extern int close_lock_file(struct lock_file *);
Junio C Hamano021b6e42006-06-06 12:51:49 -0700576extern void rollback_lock_file(struct lock_file *);
Miklos Vajnaeca35a22008-10-26 03:33:56 +0100577extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
Linus Torvalds734aab72005-04-09 09:48:20 -0700578
Junio C Hamano2ae1c532006-02-27 14:47:45 -0800579/* Environment bits from configuration mechanism */
Linus Torvalds17712992005-10-10 16:31:08 -0700580extern int trust_executable_bit;
Alex Riesen1ce47902008-07-28 08:31:28 +0200581extern int trust_ctime;
Junio C Hamano9378c162007-06-24 15:11:24 -0700582extern int quote_path_fully;
Johannes Sixt78a8d642007-03-02 22:11:30 +0100583extern int has_symlinks;
Linus Torvaldsdce96482010-10-28 11:28:04 -0700584extern int minimum_abbrev, default_abbrev;
Linus Torvalds0a9b88b2008-03-21 16:52:46 -0700585extern int ignore_case;
Junio C Hamano5f730762006-02-08 21:15:24 -0800586extern int assume_unchanged;
Junio C Hamano9f0bb902006-05-02 00:40:24 -0700587extern int prefer_symlink_refs;
Shawn Pearce6de08ae2006-05-17 05:55:40 -0400588extern int log_all_ref_updates;
Junio C Hamano2f8acdb2006-03-20 18:45:47 -0800589extern int warn_ambiguous_refs;
Johannes Schindelin457f06d2005-12-22 23:13:56 +0100590extern int shared_repository;
Junio C Hamano2ae1c532006-02-27 14:47:45 -0800591extern const char *apply_default_whitespace;
Giuseppe Bilotta86c91f92009-08-04 13:16:49 +0200592extern const char *apply_default_ignorewhitespace;
Junio C Hamano64589a02011-10-06 13:22:24 -0500593extern const char *git_attributes_file;
Joachim B Haga12f6c302006-07-03 22:11:47 +0200594extern int zlib_compression_level;
Dana How960ccca2007-05-09 13:56:50 -0700595extern int core_compression_level;
596extern int core_compression_seen;
Shawn O. Pearce60bb8b12006-12-23 02:34:28 -0500597extern size_t packed_git_window_size;
Shawn O. Pearce77ccc5b2006-12-23 02:33:35 -0500598extern size_t packed_git_limit;
Shawn O. Pearce18bdec12007-03-19 01:14:37 -0400599extern size_t delta_base_cache_limit;
Junio C Hamano15366282011-04-05 10:44:11 -0700600extern unsigned long big_file_threshold;
Junio C Hamano568508e2011-10-28 14:48:40 -0700601extern unsigned long pack_size_limit_cfg;
Christian Couderdae556b2009-01-23 10:07:46 +0100602extern int read_replace_refs;
Linus Torvaldsaafe9fb2008-06-18 15:18:44 -0700603extern int fsync_object_files;
Linus Torvalds671c9b72008-11-13 16:36:30 -0800604extern int core_preload_index;
Nguyễn Thái Ngọc Duy08aefc92009-08-20 20:47:08 +0700605extern int core_apply_sparse_checkout;
Linus Torvalds17712992005-10-10 16:31:08 -0700606
Jay Soffian9ed36cf2008-02-19 11:24:37 -0500607enum branch_track {
Alex Riesen9188ed82008-08-21 19:23:20 +0200608 BRANCH_TRACK_UNSPECIFIED = -1,
Jay Soffian9ed36cf2008-02-19 11:24:37 -0500609 BRANCH_TRACK_NEVER = 0,
610 BRANCH_TRACK_REMOTE,
611 BRANCH_TRACK_ALWAYS,
612 BRANCH_TRACK_EXPLICIT,
Gary V. Vaughan4b055482010-05-14 09:31:35 +0000613 BRANCH_TRACK_OVERRIDE
Jay Soffian9ed36cf2008-02-19 11:24:37 -0500614};
615
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700616enum rebase_setup_type {
617 AUTOREBASE_NEVER = 0,
618 AUTOREBASE_LOCAL,
619 AUTOREBASE_REMOTE,
Gary V. Vaughan4b055482010-05-14 09:31:35 +0000620 AUTOREBASE_ALWAYS
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700621};
622
Finn Arne Gangstad52153742009-03-16 16:42:51 +0100623enum push_default_type {
Finn Arne Gangstad52153742009-03-16 16:42:51 +0100624 PUSH_DEFAULT_NOTHING = 0,
625 PUSH_DEFAULT_MATCHING,
Johan Herland53c40312011-02-16 01:54:24 +0100626 PUSH_DEFAULT_UPSTREAM,
Gary V. Vaughan4b055482010-05-14 09:31:35 +0000627 PUSH_DEFAULT_CURRENT
Finn Arne Gangstad52153742009-03-16 16:42:51 +0100628};
629
Jay Soffian9ed36cf2008-02-19 11:24:37 -0500630extern enum branch_track git_branch_track;
Dustin Sallingsc998ae92008-05-10 15:36:29 -0700631extern enum rebase_setup_type autorebase;
Finn Arne Gangstad52153742009-03-16 16:42:51 +0100632extern enum push_default_type push_default;
Jay Soffian9ed36cf2008-02-19 11:24:37 -0500633
Johannes Schindelin348df162009-04-28 00:32:25 +0200634enum object_creation_mode {
635 OBJECT_CREATION_USES_HARDLINKS = 0,
Gary V. Vaughan4b055482010-05-14 09:31:35 +0000636 OBJECT_CREATION_USES_RENAMES = 1
Johannes Schindelin348df162009-04-28 00:32:25 +0200637};
638
639extern enum object_creation_mode object_creation_mode;
Johannes Schindelinbe66a6c2009-04-25 11:57:14 +0200640
Johannes Schindelina97a7462009-10-09 12:21:57 +0200641extern char *notes_ref_name;
642
Johannes Schindelin7f3140c2009-07-23 17:33:49 +0200643extern int grafts_replace_parents;
644
Junio C Hamanoab9cb762005-11-25 15:59:09 -0800645#define GIT_REPO_VERSION 0
646extern int repository_format_version;
647extern int check_repository_format(void);
648
Linus Torvalds734aab72005-04-09 09:48:20 -0700649#define MTIME_CHANGED 0x0001
650#define CTIME_CHANGED 0x0002
651#define OWNER_CHANGED 0x0004
652#define MODE_CHANGED 0x0008
653#define INODE_CHANGED 0x0010
654#define DATA_CHANGED 0x0020
Kay Sievers8ae0a8c2005-05-05 14:38:25 +0200655#define TYPE_CHANGED 0x0040
Linus Torvaldse83c5162005-04-07 15:13:13 -0700656
Alex Riesen108bebe2008-10-26 22:59:13 +0100657extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
658 __attribute__((format (printf, 3, 4)));
Alex Riesenfe2d7772008-10-27 10:22:21 +0100659extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
660 __attribute__((format (printf, 3, 4)));
Alex Riesenaba13e72008-10-27 11:17:51 +0100661extern char *git_pathdup(const char *fmt, ...)
662 __attribute__((format (printf, 1, 2)));
Alex Riesen108bebe2008-10-26 22:59:13 +0100663
Linus Torvaldse83c5162005-04-07 15:13:13 -0700664/* Return a statically allocated filename matching the sha1 signature */
Timo Sirainen4ec99bf2005-08-09 18:30:22 +0300665extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
666extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
Heiko Voigt0bad6112010-07-07 15:39:11 +0200667extern char *git_path_submodule(const char *path, const char *fmt, ...)
668 __attribute__((format (printf, 2, 3)));
669
Linus Torvalds73134b62005-04-10 14:03:58 -0700670extern char *sha1_file_name(const unsigned char *sha1);
barkalow@iabervon.orgbf592c52005-07-31 20:53:44 -0400671extern char *sha1_pack_name(const unsigned char *sha1);
672extern char *sha1_pack_index_name(const unsigned char *sha1);
Junio C Hamano013f2762005-10-11 15:22:48 -0700673extern const char *find_unique_abbrev(const unsigned char *sha1, int);
Junio C Hamano88cd6212005-09-30 14:02:47 -0700674extern const unsigned char null_sha1[20];
Ingo Molnar1a812f32011-04-28 12:19:02 +0200675
David Rientjesa89fccd2006-08-17 11:54:57 -0700676static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
677{
Ingo Molnar1a812f32011-04-28 12:19:02 +0200678 int i;
679
680 for (i = 0; i < 20; i++, sha1++, sha2++) {
681 if (*sha1 != *sha2)
682 return *sha1 - *sha2;
683 }
684
685 return 0;
David Rientjesa89fccd2006-08-17 11:54:57 -0700686}
Ingo Molnar1a812f32011-04-28 12:19:02 +0200687
688static inline int is_null_sha1(const unsigned char *sha1)
689{
690 return !hashcmp(sha1, null_sha1);
691}
692
Shawn Pearcee7024962006-08-23 02:49:00 -0400693static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
694{
695 memcpy(sha_dst, sha_src, 20);
696}
Junio C Hamanoa8e0d162006-08-23 13:57:23 -0700697static inline void hashclr(unsigned char *hash)
698{
699 memset(hash, 0, 20);
700}
Linus Torvaldse83c5162005-04-07 15:13:13 -0700701
Jeff King14d9c572008-11-12 03:17:52 -0500702#define EMPTY_TREE_SHA1_HEX \
703 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
Jonathan Niederdab0d412011-02-07 02:17:27 -0600704#define EMPTY_TREE_SHA1_BIN_LITERAL \
Jeff King14d9c572008-11-12 03:17:52 -0500705 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
706 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
Jonathan Niederdab0d412011-02-07 02:17:27 -0600707#define EMPTY_TREE_SHA1_BIN \
708 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
Jeff King14d9c572008-11-12 03:17:52 -0500709
Holger Eitzenbergerf2db68e2005-08-04 22:43:03 +0200710int git_mkstemp(char *path, size_t n, const char *template);
711
David Aguilar003b33a2009-05-31 01:35:52 -0700712int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
713
Matthieu Moyb862b612010-02-22 23:32:13 +0100714/* set default permissions by passing mode arguments to open(2) */
715int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
716int git_mkstemp_mode(char *pattern, int mode);
717
Heikki Orsila06cbe852008-04-16 11:34:24 +0300718/*
719 * NOTE NOTE NOTE!!
720 *
721 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
722 * not be changed. Old repositories have core.sharedrepository written in
723 * numeric format, and therefore these values are preserved for compatibility
724 * reasons.
725 */
Junio C Hamano94df2502006-06-09 23:09:49 -0700726enum sharedrepo {
Heikki Orsila06cbe852008-04-16 11:34:24 +0300727 PERM_UMASK = 0,
728 OLD_PERM_GROUP = 1,
729 OLD_PERM_EVERYBODY = 2,
730 PERM_GROUP = 0660,
Gary V. Vaughan4b055482010-05-14 09:31:35 +0000731 PERM_EVERYBODY = 0664
Junio C Hamano94df2502006-06-09 23:09:49 -0700732};
733int git_config_perm(const char *var, const char *value);
Junio C Hamano17e61b82009-03-27 23:21:00 -0700734int set_shared_perm(const char *path, int mode);
735#define adjust_shared_perm(path) set_shared_perm((path), 0)
Junio C Hamanob2cb9422005-07-06 01:11:52 -0700736int safe_create_leading_directories(char *path);
Jeff King8e21d632008-06-25 01:41:34 -0400737int safe_create_leading_directories_const(const char *path);
Junio C Hamano90a64642011-03-10 16:02:50 -0800738int mkdir_in_gitdir(const char *path);
Matthieu Moy395de252009-11-17 18:24:25 +0100739extern char *expand_user_path(const char *path);
Erik Faye-Lund1c64b482011-10-04 16:02:00 -0400740const char *enter_repo(const char *path, int strict);
Johannes Schindeline5392c52007-08-01 01:28:59 +0100741static inline int is_absolute_path(const char *path)
742{
Theo Niessink88135202011-05-27 18:00:38 +0200743 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
Johannes Schindeline5392c52007-08-01 01:28:59 +0100744}
Junio C Hamano90b4a712008-09-09 01:27:07 -0700745int is_directory(const char *);
Carlos Martín Nietoe2a57aa2011-03-17 12:26:46 +0100746const char *real_path(const char *path);
747const char *absolute_path(const char *path);
748const char *relative_path(const char *abs, const char *base);
Johannes Sixtf3cad0a2009-02-07 16:08:28 +0100749int normalize_path_copy(char *dst, const char *src);
David Reiss0454dd92008-05-19 23:49:26 -0700750int longest_ancestor_length(const char *path, const char *prefix_list);
Johannes Schindelin4fcc86b2009-02-19 20:10:49 +0100751char *strip_path_suffix(const char *path, const char *suffix);
Shawn O. Pearce34b6cb82009-11-09 11:26:43 -0800752int daemon_avoid_alias(const char *path);
Nguyễn Thái Ngọc Duy4bb43de2010-02-16 12:22:08 +0700753int offset_1st_component(const char *path);
Junio C Hamanob2cb9422005-07-06 01:11:52 -0700754
Junio C Hamanoe1111ce2011-05-15 12:54:53 -0700755/* object replacement */
Junio C Hamano5bf29b92011-05-15 12:54:54 -0700756#define READ_SHA1_FILE_REPLACE 1
757extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
Christian Couderf5552ae2009-01-23 10:07:01 +0100758static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
759{
Junio C Hamano5bf29b92011-05-15 12:54:54 -0700760 return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
Christian Couderf5552ae2009-01-23 10:07:01 +0100761}
Junio C Hamanoe1111ce2011-05-15 12:54:53 -0700762extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
763static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
764{
765 if (!read_replace_refs)
766 return sha1;
767 return do_lookup_replace_object(sha1);
768}
769
Nicolas Pitre21666f12007-02-26 14:55:59 -0500770/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
Nicolas Pitre21666f12007-02-26 14:55:59 -0500771extern int sha1_object_info(const unsigned char *, unsigned long *);
Nicolas Pitrece9fbf12007-03-20 16:02:09 -0400772extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
Jeff Kingc00e6572010-04-01 20:03:18 -0400773extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
Nicolas Pitre21666f12007-02-26 14:55:59 -0500774extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
Nicolas Pitrebbac7312008-05-14 01:32:48 -0400775extern int force_object_loose(const unsigned char *sha1, time_t mtime);
Junio C Hamanof0270ef2011-05-14 19:42:10 -0700776extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
Junio C Hamanoeb4f4072011-07-19 09:33:03 -0700777extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
Junio C Hamanof0270ef2011-05-14 19:42:10 -0700778extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
Daniel Barkalow8237b182005-04-23 18:47:23 -0700779
Nicolas Pitre0e8189e2008-10-31 11:31:08 -0400780/* global flag to enable extra checks when accessing packed objects */
781extern int do_check_packed_object_crc;
782
Junio C Hamano5f443242011-07-06 19:08:55 -0700783/* for development: log offset of pack access */
784extern const char *log_pack_access;
785
Jason McMullan5d6ccf52005-06-03 11:05:39 -0400786extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
Linus Torvaldse83c5162005-04-07 15:13:13 -0700787
Junio C Hamano839837b2006-09-01 00:17:47 -0700788extern int move_temp_to_file(const char *tmpfile, const char *filename);
Daniel Barkalow8237b182005-04-23 18:47:23 -0700789
Junio C Hamanocd673c12009-02-27 23:15:53 -0800790extern int has_sha1_pack(const unsigned char *sha1);
Daniel Barkalow8237b182005-04-23 18:47:23 -0700791extern int has_sha1_file(const unsigned char *sha1);
Brandon Casey0f4dc142008-11-09 23:59:57 -0600792extern int has_loose_object_nonlocal(const unsigned char *sha1);
Daniel Barkalow8237b182005-04-23 18:47:23 -0700793
barkalow@iabervon.orgbf592c52005-07-31 20:53:44 -0400794extern int has_pack_index(const unsigned char *sha1);
795
Jeff King40d52ff2010-04-01 20:05:23 -0400796extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
797
Linus Torvalds192a6be2007-05-30 10:32:19 -0700798extern const signed char hexval_table[256];
799static inline unsigned int hexval(unsigned char c)
Junio C Hamanoe49521b2006-09-20 16:04:46 -0700800{
801 return hexval_table[c];
802}
803
Linus Torvaldse83c5162005-04-07 15:13:13 -0700804/* Convert to/from hex/sha1 representation */
Linus Torvaldsdce96482010-10-28 11:28:04 -0700805#define MINIMUM_ABBREV minimum_abbrev
806#define DEFAULT_ABBREV default_abbrev
Junio C Hamano46a6c262006-01-25 01:03:18 -0800807
Clément Poulain573285e2010-06-09 19:02:06 +0200808struct object_context {
809 unsigned char tree[20];
810 char path[PATH_MAX];
811 unsigned mode;
812};
813
Linus Torvalds3c249c92005-05-01 16:36:56 -0700814extern int get_sha1(const char *str, unsigned char *sha1);
Junio C Hamano2e83b662011-05-10 12:02:54 -0700815extern int get_sha1_with_mode_1(const char *str, unsigned char *sha1, unsigned *mode, int only_to_die, const char *prefix);
Matthieu Moy009fee42009-12-07 11:10:50 +0100816static inline int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode)
817{
Junio C Hamano2e83b662011-05-10 12:02:54 -0700818 return get_sha1_with_mode_1(str, sha1, mode, 0, NULL);
Matthieu Moy009fee42009-12-07 11:10:50 +0100819}
Junio C Hamano2e83b662011-05-10 12:02:54 -0700820extern int get_sha1_with_context_1(const char *name, unsigned char *sha1, struct object_context *orc, int only_to_die, const char *prefix);
Clément Poulain573285e2010-06-09 19:02:06 +0200821static inline int get_sha1_with_context(const char *str, unsigned char *sha1, struct object_context *orc)
822{
Junio C Hamano2e83b662011-05-10 12:02:54 -0700823 return get_sha1_with_context_1(str, sha1, orc, 0, NULL);
Clément Poulain573285e2010-06-09 19:02:06 +0200824}
Michael Haggertyd4e85a12011-09-23 15:38:36 +0200825
826/*
827 * Try to read a SHA1 in hexadecimal format from the 40 characters
828 * starting at hex. Write the 20-byte result to sha1 in binary form.
829 * Return 0 on success. Reading stops if a NUL is encountered in the
830 * input, so it is safe to pass this function an arbitrary
831 * null-terminated string.
832 */
Linus Torvalds197ee8c2005-04-09 12:09:27 -0700833extern int get_sha1_hex(const char *hex, unsigned char *sha1);
Michael Haggertyd4e85a12011-09-23 15:38:36 +0200834
Linus Torvalds197ee8c2005-04-09 12:09:27 -0700835extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
Michael Haggertydfefa932011-12-12 06:38:09 +0100836extern int read_ref_full(const char *refname, unsigned char *sha1,
Nguyễn Thái Ngọc Duyc6893322011-11-13 17:22:14 +0700837 int reading, int *flags);
Michael Haggertydfefa932011-12-12 06:38:09 +0100838extern int read_ref(const char *refname, unsigned char *sha1);
Michael Haggerty7cb36842011-09-15 23:10:42 +0200839
840/*
841 * Resolve a reference, recursively following symbolic refererences.
842 *
843 * Store the referred-to object's name in sha1 and return the name of
844 * the non-symbolic reference that ultimately pointed at it. The
845 * return value, if not NULL, is a pointer into either a static buffer
846 * or the input ref.
847 *
848 * If the reference cannot be resolved to an object, the behavior
849 * depends on the "reading" argument:
850 *
851 * - If reading is set, return NULL.
852 *
853 * - If reading is not set, clear sha1 and return the name of the last
854 * reference name in the chain, which will either be a non-symbolic
855 * reference or an undefined reference. If this is a prelude to
856 * "writing" to the ref, the return value is the name of the ref
857 * that will actually be created or changed.
858 *
859 * If flag is non-NULL, set the value that it points to the
860 * combination of REF_ISPACKED (if the reference was found among the
861 * packed references) and REF_ISSYMREF (if the initial reference was a
862 * symbolic reference).
863 *
864 * If ref is not a properly-formatted, normalized reference, return
865 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
866 * give up and return NULL.
867 *
868 * errno is sometimes set on errors, but not always.
869 */
Nguyễn Thái Ngọc Duy8cad4742011-12-12 18:20:32 +0700870extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
Nguyễn Thái Ngọc Duy96ec7b12011-12-13 21:17:48 +0700871extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
Michael Haggerty7cb36842011-09-15 23:10:42 +0200872
Junio C Hamanoe86eb662007-01-19 01:15:15 -0800873extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
Johannes Schindelineb3a4822007-02-09 01:28:23 +0100874extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
Junio C Hamano431b1962009-03-21 12:51:34 -0700875extern int interpret_branch_name(const char *str, struct strbuf *);
Junio C Hamano619a6442009-10-18 12:34:56 -0700876extern int get_sha1_mb(const char *str, unsigned char *sha1);
Junio C Hamanoe86eb662007-01-19 01:15:15 -0800877
Steffen Prohaska79803322007-11-11 15:01:46 +0100878extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
879extern const char *ref_rev_parse_rules[];
Junio C Hamanodd621df2011-11-04 14:14:05 -0700880#define ref_fetch_rules ref_rev_parse_rules
Steffen Prohaska79803322007-11-11 15:01:46 +0100881
Nicolas Pitre8b5157e2007-01-26 17:26:10 -0500882extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
Junio C Hamanoc847f532007-01-01 23:31:08 -0800883extern int validate_headref(const char *ref);
Linus Torvaldse83c5162005-04-07 15:13:13 -0700884
Linus Torvalds958ba6c2005-05-20 09:09:18 -0700885extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
Linus Torvalds0ab9e1e2008-03-05 18:25:10 -0800886extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
Linus Torvalds79517a02005-04-09 12:59:11 -0700887extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
Linus Torvaldse83c5162005-04-07 15:13:13 -0700888
Junio C Hamano40469ee2005-04-28 16:42:27 -0700889extern void *read_object_with_reference(const unsigned char *sha1,
Brian Gerstbf0f9102005-05-18 08:14:09 -0400890 const char *required_type,
Junio C Hamano40469ee2005-04-28 16:42:27 -0700891 unsigned long *size,
892 unsigned char *sha1_ret);
Junio C Hamanof4913f92005-04-20 18:06:49 -0700893
Junio C Hamano81776312007-12-24 00:51:01 -0800894extern struct object *peel_to_type(const char *name, int namelen,
895 struct object *o, enum object_type);
896
Junio C Hamano73013af2007-07-13 23:14:52 -0700897enum date_mode {
898 DATE_NORMAL = 0,
899 DATE_RELATIVE,
900 DATE_SHORT,
901 DATE_LOCAL,
902 DATE_ISO8601,
Linus Torvalds7dff9b32009-02-20 14:15:22 -0800903 DATE_RFC2822,
904 DATE_RAW
Junio C Hamano73013af2007-07-13 23:14:52 -0700905};
906
Johannes Schindelinf8493ec2007-02-27 16:21:04 +0100907const char *show_date(unsigned long time, int timezone, enum date_mode mode);
Alex Riesen33012fc2009-08-30 22:26:05 -0400908const char *show_date_relative(unsigned long time, int tz,
909 const struct timeval *now,
910 char *timebuf,
911 size_t timebuf_size);
Linus Torvalds2a390642005-09-19 15:53:50 -0700912int parse_date(const char *date, char *buf, int bufsize);
Jonathan Nieder9644c062010-07-15 18:22:57 +0200913int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
Edgar Toernigecee9d92005-04-30 09:46:49 -0700914void datestamp(char *buf, int bufsize);
Junio C Hamano93cfa7c2010-01-26 11:58:00 -0800915#define approxidate(s) approxidate_careful((s), NULL)
916unsigned long approxidate_careful(const char *, int *);
Alex Riesen33012fc2009-08-30 22:26:05 -0400917unsigned long approxidate_relative(const char *date, const struct timeval *now);
Andy Parkins856665f2007-09-28 15:17:31 +0100918enum date_mode parse_date_format(const char *format);
Edgar Toernigecee9d92005-04-30 09:46:49 -0700919
Junio C Hamano774751a2007-12-08 17:32:08 -0800920#define IDENT_WARN_ON_NO_NAME 1
921#define IDENT_ERROR_ON_NO_NAME 2
922#define IDENT_NO_DATE 4
Junio C Hamano749be722006-02-18 20:31:05 -0800923extern const char *git_author_info(int);
924extern const char *git_committer_info(int);
Junio C Hamano798123a2007-02-04 17:50:14 -0800925extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
Junio C Hamanod9ccfe72007-12-02 13:43:34 -0800926extern const char *fmt_name(const char *name, const char *email);
Jonathan Nieder44fcb492009-11-11 18:01:27 -0600927extern const char *git_editor(void);
Jonathan Nieder64778d22010-02-14 05:59:59 -0600928extern const char *git_pager(int stdout_is_tty);
Linus Torvalds6aa33f42005-07-12 11:49:27 -0700929
Linus Torvalds12dccc12005-06-05 21:59:54 -0700930struct checkout {
931 const char *base_dir;
932 int base_dir_len;
933 unsigned force:1,
934 quiet:1,
935 not_new:1,
936 refresh_cache:1;
937};
938
Luiz Fernando N. Capitulinoefbc5832007-04-25 11:18:08 -0300939extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
Linus Torvaldsb9fd2842009-07-09 13:35:31 -0700940
941struct cache_def {
942 char path[PATH_MAX + 1];
943 int len;
944 int flags;
945 int track_flags;
946 int prefix_len_stat_func;
947};
948
Kjetil Barvik57199892009-02-09 21:54:06 +0100949extern int has_symlink_leading_path(const char *name, int len);
Linus Torvaldsb9fd2842009-07-09 13:35:31 -0700950extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
Clemens Buchacherf66caaf2010-10-09 15:53:00 +0200951extern int check_leading_path(const char *name, int len);
Kjetil Barvik57199892009-02-09 21:54:06 +0100952extern int has_dirs_only_path(const char *name, int len, int prefix_len);
Kjetil Barvik78478922009-02-09 21:54:07 +0100953extern void schedule_dir_for_removal(const char *name, int len);
954extern void remove_scheduled_dirs(void);
Linus Torvalds12dccc12005-06-05 21:59:54 -0700955
Junio C Hamano9a217f22005-06-28 14:56:57 -0700956extern struct alternate_object_database {
Junio C Hamanod5a63b92005-08-14 17:25:57 -0700957 struct alternate_object_database *next;
Junio C Hamano9a217f22005-06-28 14:56:57 -0700958 char *name;
Junio C Hamano8f1d2e62006-01-07 01:33:54 -0800959 char base[FLEX_ARRAY]; /* more */
Junio C Hamanod5a63b92005-08-14 17:25:57 -0700960} *alt_odb_list;
Junio C Hamano9a217f22005-06-28 14:56:57 -0700961extern void prepare_alt_odb(void);
Daniel Barkalowbef70b22008-04-17 19:32:30 -0400962extern void add_to_alternates_file(const char *reference);
Junio C Hamanod79796b2008-09-09 01:27:10 -0700963typedef int alt_odb_fn(struct alternate_object_database *, void *);
964extern void foreach_alt_odb(alt_odb_fn, void*);
Junio C Hamano9a217f22005-06-28 14:56:57 -0700965
Shawn O. Pearcec41ee582006-12-23 02:33:44 -0500966struct pack_window {
967 struct pack_window *next;
968 unsigned char *base;
969 off_t offset;
970 size_t len;
971 unsigned int last_used;
972 unsigned int inuse_cnt;
973};
974
Junio C Hamano9a217f22005-06-28 14:56:57 -0700975extern struct packed_git {
976 struct packed_git *next;
Shawn O. Pearcec41ee582006-12-23 02:33:44 -0500977 struct pack_window *windows;
Shawn O. Pearce2dc3a232006-12-23 02:33:47 -0500978 off_t pack_size;
Nicolas Pitre57059092007-04-09 01:06:28 -0400979 const void *index_data;
980 size_t index_size;
981 uint32_t num_objects;
Nicolas Pitre8eca0b42008-06-23 21:23:39 -0400982 uint32_t num_bad_objects;
983 unsigned char *bad_object_sha1;
Nicolas Pitre42873072007-03-16 16:42:50 -0400984 int index_version;
Nicolas Pitre57059092007-04-09 01:06:28 -0400985 time_t mtime;
Shawn O. Pearce9bc879c2006-12-23 02:34:01 -0500986 int pack_fd;
Brandon Casey8d259312008-11-12 11:59:03 -0600987 unsigned pack_local:1,
Shawn O. Pearced131b7a2011-03-02 10:01:54 -0800988 pack_keep:1,
989 do_not_close:1;
barkalow@iabervon.orgbf592c52005-07-31 20:53:44 -0400990 unsigned char sha1[20];
Junio C Hamano8f1d2e62006-01-07 01:33:54 -0800991 /* something like ".git/objects/pack/xxxxx.pack" */
992 char pack_name[FLEX_ARRAY]; /* more */
Junio C Hamano9a217f22005-06-28 14:56:57 -0700993} *packed_git;
Junio C Hamanof3bf9222005-06-30 17:15:39 -0700994
995struct pack_entry {
Shawn O. Pearcec4001d92007-03-06 20:44:30 -0500996 off_t offset;
Junio C Hamanof3bf9222005-06-30 17:15:39 -0700997 unsigned char sha1[20];
998 struct packed_git *p;
999};
1000
Linus Torvaldsd1c133f2005-07-16 13:55:50 -07001001struct ref {
1002 struct ref *next;
1003 unsigned char old_sha1[20];
1004 unsigned char new_sha1[20];
Daniel Barkalowbe885d92008-04-26 15:53:12 -04001005 char *symref;
Shawn O. Pearce9f8a15c2007-11-18 04:31:37 -05001006 unsigned int force:1,
1007 merge:1,
1008 nonfastforward:1,
1009 deletion:1;
Jeff King8736a842007-11-17 07:54:27 -05001010 enum {
1011 REF_STATUS_NONE = 0,
1012 REF_STATUS_OK,
1013 REF_STATUS_REJECT_NONFASTFORWARD,
1014 REF_STATUS_REJECT_NODELETE,
1015 REF_STATUS_UPTODATE,
Jeff Kingca74c452007-11-17 07:56:03 -05001016 REF_STATUS_REMOTE_REJECT,
Gary V. Vaughan4b055482010-05-14 09:31:35 +00001017 REF_STATUS_EXPECTING_REPORT
Jeff King8736a842007-11-17 07:54:27 -05001018 } status;
Jeff King2a0fe892007-11-18 02:16:52 -05001019 char *remote_status;
Junio C Hamanof88395a2005-08-03 16:35:29 -07001020 struct ref *peer_ref; /* when renaming */
Junio C Hamano8f1d2e62006-01-07 01:33:54 -08001021 char name[FLEX_ARRAY]; /* more */
Linus Torvaldsd1c133f2005-07-16 13:55:50 -07001022};
1023
Linus Torvalds2718ff02006-07-04 12:29:10 -07001024#define REF_NORMAL (1u << 0)
1025#define REF_HEADS (1u << 1)
1026#define REF_TAGS (1u << 2)
1027
Jeff King5483f792009-02-25 03:32:10 -05001028extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
Jeff Kingcda69f42007-11-18 02:13:10 -05001029
Michael S. Tsirkin7841ce72007-05-16 20:09:41 +03001030#define CONNECT_VERBOSE (1u << 0)
Daniel Barkalow45773702007-10-29 21:05:40 -04001031extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
Johannes Sixt98158e92007-10-19 21:47:53 +02001032extern int finish_connect(struct child_process *conn);
Jeff King7ffe8532011-05-16 02:52:11 -04001033extern int git_connection_is_socket(struct child_process *conn);
Junio C Hamano40c155f2008-09-09 01:27:09 -07001034struct extra_have_objects {
1035 int nr, alloc;
1036 unsigned char (*array)[20];
1037};
Jeff Kingafe7c5f2011-12-12 19:41:37 -05001038extern struct ref **get_remote_heads(int in, struct ref **list, unsigned int flags, struct extra_have_objects *);
Johannes Schindelin211b5f92005-10-28 04:48:54 +02001039extern int server_supports(const char *feature);
Junio C Hamanof47182c2012-01-08 22:06:19 +01001040extern const char *parse_feature_request(const char *features, const char *feature);
Linus Torvaldsf7192592005-07-04 11:57:58 -07001041
Shawn O. Pearce7b644692010-04-19 07:23:08 -07001042extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
barkalow@iabervon.orgbf592c52005-07-31 20:53:44 -04001043
Junio C Hamano9a217f22005-06-28 14:56:57 -07001044extern void prepare_packed_git(void);
Shawn Pearcefc04c412006-11-01 17:06:21 -05001045extern void reprepare_packed_git(void);
barkalow@iabervon.orgbf592c52005-07-31 20:53:44 -04001046extern void install_packed_git(struct packed_git *pack);
1047
Junio C Hamanoa6080a02007-06-07 00:04:01 -07001048extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
barkalow@iabervon.orgbf592c52005-07-31 20:53:44 -04001049 struct packed_git *packs);
1050
Chris Wedgwood276bc2c2007-01-16 22:28:02 -08001051extern void pack_report(void);
Shawn O. Pearced0798372007-05-26 01:24:19 -04001052extern int open_pack_index(struct packed_git *);
Shawn O. Pearcefa5fc152010-04-19 07:23:06 -07001053extern void close_pack_index(struct packed_git *);
Junio C Hamanoef49a7a2011-06-10 11:52:15 -07001054extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
Shawn O. Pearcec9ced052008-01-17 22:57:00 -05001055extern void close_pack_windows(struct packed_git *);
Shawn O. Pearce03e79c82006-12-23 02:34:08 -05001056extern void unuse_pack(struct pack_window **);
Nicolas Pitrec74faea2008-12-09 14:26:52 -05001057extern void free_pack_by_name(const char *);
Shawn O. Pearce3d20c632009-02-10 13:36:12 -08001058extern void clear_delta_base_cache(void);
Nicolas Pitre42873072007-03-16 16:42:50 -04001059extern struct packed_git *add_packed_git(const char *, int, int);
Shawn O. Pearced0798372007-05-26 01:24:19 -04001060extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
Nicolas Pitre99093232008-06-24 23:17:12 -04001061extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
Shawn O. Pearcec4001d92007-03-06 20:44:30 -05001062extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
Jeff King4c080182011-10-14 14:03:48 -04001063extern int is_pack_valid(struct packed_git *);
Shawn O. Pearcec4001d92007-03-06 20:44:30 -05001064extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
Nicolas Pitre09ded042008-10-29 19:02:46 -04001065extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
Nicolas Pitre54dab522007-04-16 12:31:56 -04001066extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
Junio C Hamanof8c8abc2011-05-13 15:33:33 -07001067extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
Junio C Hamano9a217f22005-06-28 14:56:57 -07001068
Junio C Hamano9a490592011-05-12 15:51:38 -07001069struct object_info {
1070 /* Request */
1071 unsigned long *sizep;
1072
1073 /* Response */
1074 enum {
1075 OI_CACHED,
1076 OI_LOOSE,
Junio C Hamano5266d362011-05-13 13:20:43 -07001077 OI_PACKED,
1078 OI_DBCACHED
Junio C Hamano9a490592011-05-12 15:51:38 -07001079 } whence;
1080 union {
1081 /*
1082 * struct {
1083 * ... Nothing to expose in this case
1084 * } cached;
1085 * struct {
1086 * ... Nothing to expose in this case
1087 * } loose;
1088 */
1089 struct {
1090 struct packed_git *pack;
1091 off_t offset;
1092 unsigned int is_delta;
1093 } packed;
1094 } u;
1095};
1096extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
Linus Torvaldse83c5162005-04-07 15:13:13 -07001097
Junio C Hamano8f3f9b02005-07-23 17:54:41 -07001098/* Dumb servers support */
1099extern int update_server_info(int);
1100
Michael J Gruber7a397412011-05-17 17:38:52 +02001101/* git_config_parse_key() returns these negated: */
1102#define CONFIG_INVALID_KEY 1
1103#define CONFIG_NO_SECTION_OR_NAME 2
1104/* git_config_set(), git_config_set_multivar() return the above or these: */
1105#define CONFIG_NO_LOCK -1
1106#define CONFIG_INVALID_FILE 3
1107#define CONFIG_NO_WRITE 4
1108#define CONFIG_NOTHING_SET 5
1109#define CONFIG_INVALID_PATTERN 6
1110
Johannes Schindelinef90d6d2008-05-14 18:46:53 +01001111typedef int (*config_fn_t)(const char *, const char *, void *);
1112extern int git_default_config(const char *, const char *, void *);
1113extern int git_config_from_file(config_fn_t fn, const char *, void *);
Jeff King2b64fc82010-08-23 15:16:00 -04001114extern void git_config_push_parameter(const char *text);
Thomas Rastb3d83d92010-05-21 12:07:47 +02001115extern int git_config_from_parameters(config_fn_t fn, void *data);
Johannes Schindelinef90d6d2008-05-14 18:46:53 +01001116extern int git_config(config_fn_t fn, void *);
Nguyễn Thái Ngọc Duydbdf5852010-11-26 22:32:33 +07001117extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
Brian Downing0b87b6e2007-07-12 08:32:26 -05001118extern int git_parse_ulong(const char *, unsigned long *);
Linus Torvalds17712992005-10-10 16:31:08 -07001119extern int git_config_int(const char *, const char *);
Brian Downing0b87b6e2007-07-12 08:32:26 -05001120extern unsigned long git_config_ulong(const char *, const char *);
Junio C Hamanoa53f2ec2008-04-12 18:33:31 -07001121extern int git_config_bool_or_int(const char *, const char *, int *);
Linus Torvalds17712992005-10-10 16:31:08 -07001122extern int git_config_bool(const char *, const char *);
Junio C Hamano8420ccd2010-02-16 23:59:46 -08001123extern int git_config_maybe_bool(const char *, const char *);
Christian Couderea5105a2008-02-16 06:00:24 +01001124extern int git_config_string(const char **, const char *, const char *);
Matthieu Moy395de252009-11-17 18:24:25 +01001125extern int git_config_pathname(const char **, const char *, const char *);
Ramkumar Ramachandra5ec31182011-08-04 16:09:00 +05301126extern int git_config_set_in_file(const char *, const char *, const char *);
Johannes Schindelin10bea152005-11-17 22:32:36 +01001127extern int git_config_set(const char *, const char *);
Libor Pechacekb09c53a2011-01-30 20:40:41 +01001128extern int git_config_parse_key(const char *, char **, int *);
Johannes Schindelin4ddba792005-11-20 06:52:22 +01001129extern int git_config_set_multivar(const char *, const char *, const char *, int);
Ramkumar Ramachandra5ec31182011-08-04 16:09:00 +05301130extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
Johannes Schindelin0667fcf2006-12-16 15:14:14 +01001131extern int git_config_rename_section(const char *, const char *);
Johannes Sixt506b17b2007-11-13 21:05:05 +01001132extern const char *git_etc_gitconfig(void);
Johannes Schindelinef90d6d2008-05-14 18:46:53 +01001133extern int check_repository_format_version(const char *var, const char *value, void *cb);
Lars R. Damerow0ef37162010-03-17 12:55:51 -07001134extern int git_env_bool(const char *, int);
Jeff Kingab88c362008-02-06 05:11:18 -05001135extern int git_config_system(void);
Junio C Hamano40ea4ed2008-02-11 10:41:18 -08001136extern int config_error_nonbool(const char *);
Pat Notza6fa5992010-11-02 13:59:07 -06001137extern const char *get_log_output_encoding(void);
1138extern const char *get_commit_output_encoding(void);
1139
Jeff King24968442011-06-09 11:56:42 -04001140extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1141
Daniel Barkalowdc871832008-06-30 03:37:47 -04001142extern const char *config_exclusive_filename;
Linus Torvalds17712992005-10-10 16:31:08 -07001143
Linus Torvaldse1b10392005-10-11 18:47:34 -07001144#define MAX_GITNAME (1000)
1145extern char git_default_email[MAX_GITNAME];
1146extern char git_default_name[MAX_GITNAME];
Junio C Hamano91c38a22010-01-08 07:39:11 -08001147#define IDENT_NAME_GIVEN 01
1148#define IDENT_MAIL_GIVEN 02
1149#define IDENT_ALL_GIVEN (IDENT_NAME_GIVEN|IDENT_MAIL_GIVEN)
Santi Béjarbb1ae3f2008-05-04 18:04:51 +02001150extern int user_ident_explicitly_given;
Junio C Hamano5aeb3a32010-01-17 13:54:28 -08001151extern int user_ident_sufficiently_given(void);
Linus Torvaldse1b10392005-10-11 18:47:34 -07001152
Shawn O. Pearce1a8f2742007-03-12 15:33:18 -04001153extern const char *git_commit_encoding;
Shawn O. Pearce3a556022007-03-06 20:44:17 -05001154extern const char *git_log_output_encoding;
Marius Storm-Olsend551a482009-02-08 15:34:27 +01001155extern const char *git_mailmap_file;
Junio C Hamano4e72dce2005-11-27 16:09:40 -08001156
Theodore Ts'o06f59e92007-06-29 13:40:46 -04001157/* IO helper functions */
1158extern void maybe_flush_or_die(FILE *, const char *);
Junio C Hamanof3123c42005-10-22 01:28:13 -07001159extern int copy_fd(int ifd, int ofd);
Daniel Barkalow1468bd42008-02-25 14:24:48 -05001160extern int copy_file(const char *dst, const char *src, int mode);
Clemens Buchacherf7835a22009-09-12 11:03:48 +02001161extern int copy_file_with_time(const char *dst, const char *src, int mode);
Rene Scharfe7230e6d2006-08-21 20:43:43 +02001162extern void write_or_die(int fd, const void *buf, size_t count);
Christian Couder6ce4e612006-09-02 18:23:48 +02001163extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
Andy Whitcrofte0814052007-01-08 15:57:52 +00001164extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
Linus Torvalds4c81b032008-05-30 08:42:16 -07001165extern void fsync_or_die(int fd, const char *);
Junio C Hamanoad897212005-12-14 22:17:38 -08001166
Jim Meyering2b7ca832009-09-12 10:54:32 +02001167extern ssize_t read_in_full(int fd, void *buf, size_t count);
1168extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1169static inline ssize_t write_str_in_full(int fd, const char *str)
1170{
1171 return write_in_full(fd, str, strlen(str));
1172}
1173
Linus Torvaldsf67b45f2006-02-28 11:26:21 -08001174/* pager.c */
1175extern void setup_pager(void);
Christian Couder872da322008-02-16 06:01:11 +01001176extern const char *pager_program;
Jeff King6e9af862007-12-11 01:27:33 -05001177extern int pager_in_use(void);
Matthias Lederhoferaa086eb2006-07-30 00:27:43 +02001178extern int pager_use_color;
Linus Torvaldsf67b45f2006-02-28 11:26:21 -08001179
Christian Couderee9601e2008-02-16 06:01:41 +01001180extern const char *editor_program;
Anselm Kruisd3e7da82010-08-30 15:38:38 +02001181extern const char *askpass_program;
Christian Couderdfb068b2008-02-16 06:01:59 +01001182extern const char *excludes_file;
Johannes Schindelin4d87b9c2007-07-20 13:06:09 +01001183
Junio C Hamano051308f2006-05-04 16:51:44 -07001184/* base85 */
Jim Meyeringf9815772007-04-10 00:56:33 +02001185int decode_85(char *dst, const char *line, int linelen);
1186void encode_85(char *buf, const unsigned char *data, int bytes);
Junio C Hamano051308f2006-05-04 16:51:44 -07001187
Linus Torvalds855419f2006-06-19 10:44:15 -07001188/* alloc.c */
Linus Torvalds100c5f32007-04-16 22:11:43 -07001189extern void *alloc_blob_node(void);
1190extern void *alloc_tree_node(void);
1191extern void *alloc_commit_node(void);
1192extern void *alloc_tag_node(void);
1193extern void *alloc_object_node(void);
Linus Torvalds855419f2006-06-19 10:44:15 -07001194extern void alloc_report(void);
1195
Christian Couder6ce4e612006-09-02 18:23:48 +02001196/* trace.c */
Tarmigan Casebolt28bea9e2009-11-14 13:33:13 -08001197__attribute__((format (printf, 1, 2)))
Christian Couder6ce4e612006-09-02 18:23:48 +02001198extern void trace_printf(const char *format, ...);
Jeff King06796602011-02-24 09:28:41 -05001199extern void trace_vprintf(const char *key, const char *format, va_list ap);
Tarmigan Casebolt28bea9e2009-11-14 13:33:13 -08001200__attribute__((format (printf, 2, 3)))
Christian Couderb319ce42007-12-03 05:51:50 +01001201extern void trace_argv_printf(const char **argv, const char *format, ...);
Nguyễn Thái Ngọc Duya9ca8a82010-11-26 22:31:57 +07001202extern void trace_repo_setup(const char *prefix);
Jeff King39bc5e42011-02-24 09:28:59 -05001203extern int trace_want(const char *key);
Jeff King94b3b372011-02-24 09:29:50 -05001204extern void trace_strbuf(const char *key, const struct strbuf *buf);
Christian Couder6ce4e612006-09-02 18:23:48 +02001205
Jeff Kingbbc30f92011-02-24 09:30:19 -05001206void packet_trace_identity(const char *prog);
Linus Torvaldse83c5162005-04-07 15:13:13 -07001207
Junio C Hamanob6ec1d62007-11-18 01:12:04 -08001208/* add */
Alex Riesen7ae02a32008-05-12 19:58:10 +02001209/*
1210 * return 0 if success, 1 - if addition of a file failed and
1211 * ADD_FILES_IGNORE_ERRORS was specified in flags
1212 */
1213int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
Junio C Hamanob6ec1d62007-11-18 01:12:04 -08001214
Junio C Hamanoaecbf912007-08-31 13:13:42 -07001215/* diff.c */
1216extern int diff_auto_refresh_index;
1217
Junio C Hamano68faf682007-02-15 16:32:45 -08001218/* match-trees.c */
1219void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
Junio C Hamano85e51b72008-06-30 22:18:57 -07001220void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
Junio C Hamano68faf682007-02-15 16:32:45 -08001221
Junio C Hamanoa9cc8572007-11-02 00:24:27 -07001222/*
1223 * whitespace rules.
1224 * used by both diff and apply
Johannes Sixtf4b05a42010-11-30 09:29:11 +01001225 * last two digits are tab width
Junio C Hamanoa9cc8572007-11-02 00:24:27 -07001226 */
Johannes Sixtf4b05a42010-11-30 09:29:11 +01001227#define WS_BLANK_AT_EOL 0100
1228#define WS_SPACE_BEFORE_TAB 0200
1229#define WS_INDENT_WITH_NON_TAB 0400
1230#define WS_CR_AT_EOL 01000
1231#define WS_BLANK_AT_EOF 02000
1232#define WS_TAB_IN_INDENT 04000
Junio C Hamanoaeb84b02009-09-05 22:21:17 -07001233#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
Johannes Sixtf4b05a42010-11-30 09:29:11 +01001234#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1235#define WS_TAB_WIDTH_MASK 077
Junio C Hamanocf1b7862007-12-06 00:14:14 -08001236extern unsigned whitespace_rule_cfg;
1237extern unsigned whitespace_rule(const char *);
1238extern unsigned parse_whitespace_rule(const char *);
Junio C Hamano8f8841e2008-06-26 15:35:21 -07001239extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1240extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
Wincent Colaiutac1795bb2007-12-13 14:32:29 +01001241extern char *whitespace_error_string(unsigned ws);
Chris Webbd511bd32010-04-03 00:37:23 +01001242extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
Junio C Hamano877f23c2008-06-26 15:36:59 -07001243extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
Johannes Sixtf4b05a42010-11-30 09:29:11 +01001244#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
Junio C Hamanoa9cc8572007-11-02 00:24:27 -07001245
Junio C Hamanoee425e42007-11-18 01:13:32 -08001246/* ls-files */
Clemens Buchacher0f64bfa2011-08-01 23:19:58 +02001247int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix);
Junio C Hamanoee425e42007-11-18 01:13:32 -08001248void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1249
Jeff King94351112008-02-24 17:17:14 -05001250char *alias_lookup(const char *alias);
Miklos Vajna0989fe92008-06-27 18:21:54 +02001251int split_cmdline(char *cmdline, const char ***argv);
Greg Brockmanad9ac6d2010-08-07 01:13:39 -04001252/* Takes a negative value returned by split_cmdline */
1253const char *split_cmdline_strerror(int cmdline_errno);
Jeff King94351112008-02-24 17:17:14 -05001254
Nguyễn Thái Ngọc Duye37c1322010-08-05 21:40:35 -05001255/* git.c */
1256struct startup_info {
Nguyễn Thái Ngọc Duya60645f2010-08-05 21:46:33 -05001257 int have_repository;
Nguyễn Thái Ngọc Duyf07d6a12010-12-01 17:33:22 -06001258 const char *prefix;
Nguyễn Thái Ngọc Duye37c1322010-08-05 21:40:35 -05001259};
1260extern struct startup_info *startup_info;
1261
Junio C Hamanocac42b22010-03-06 21:34:41 +01001262/* builtin/merge.c */
1263int checkout_fast_forward(const unsigned char *from, const unsigned char *to);
1264
Linus Torvaldse83c5162005-04-07 15:13:13 -07001265#endif /* CACHE_H */