🌐 AI搜索 & 代理 主页
blob: 99ed096aed03b865dd6e263474e6e6a265681b91 [file] [log] [blame]
Linus Torvaldse83c5162005-04-07 22:13:131#ifndef CACHE_H
2#define CACHE_H
3
Junio C Hamano4050c0d2005-12-05 19:54:294#include "git-compat-util.h"
Pierre Habouzit5ecd2932007-09-16 13:51:045#include "strbuf.h"
Karsten Bleese05881a2013-11-14 19:20:586#include "hashmap.h"
Jeff King75194432009-09-09 11:38:587#include "advice.h"
Ævar Arnfjörð Bjarmason65784832011-02-22 23:41:208#include "gettext.h"
Junio C Hamanod1bf0e02011-05-20 19:59:019#include "convert.h"
Karsten Blees5991a552014-06-11 07:56:4910#include "trace.h"
Tanay Abhra155ef252014-08-07 11:59:1711#include "string-list.h"
Linus Torvaldse83c5162005-04-07 22:13:1312
Linus Torvaldscef661f2005-04-21 19:33:2213#include SHA1_HEADER
Nicolas Pitre9126f002008-10-01 18:05:2014#ifndef git_SHA_CTX
15#define git_SHA_CTX SHA_CTX
16#define git_SHA1_Init SHA1_Init
17#define git_SHA1_Update SHA1_Update
18#define git_SHA1_Final SHA1_Final
19#endif
Linus Torvaldse83c5162005-04-07 22:13:1320
Nicolas Pitre9126f002008-10-01 18:05:2021#include <zlib.h>
Junio C Hamanoef49a7a2011-06-10 18:52:1522typedef struct git_zstream {
23 z_stream z;
24 unsigned long avail_in;
25 unsigned long avail_out;
26 unsigned long total_in;
27 unsigned long total_out;
28 unsigned char *next_in;
29 unsigned char *next_out;
30} git_zstream;
Edgar Toernig9da3acf2005-04-30 16:51:0331
Junio C Hamanoef49a7a2011-06-10 18:52:1532void git_inflate_init(git_zstream *);
33void git_inflate_init_gzip_only(git_zstream *);
34void git_inflate_end(git_zstream *);
35int git_inflate(git_zstream *, int flush);
Linus Torvalds39c68542009-01-08 03:54:4736
Junio C Hamanoef49a7a2011-06-10 18:52:1537void git_deflate_init(git_zstream *, int level);
38void git_deflate_init_gzip(git_zstream *, int level);
René Scharfec3c2e1a2013-03-15 22:21:5139void git_deflate_init_raw(git_zstream *, int level);
Junio C Hamanoef49a7a2011-06-10 18:52:1540void git_deflate_end(git_zstream *);
Junio C Hamano568508e2011-10-28 21:48:4041int git_deflate_abort(git_zstream *);
Junio C Hamanoef49a7a2011-06-10 18:52:1542int git_deflate_end_gently(git_zstream *);
43int git_deflate(git_zstream *, int flush);
44unsigned long git_deflate_bound(git_zstream *, unsigned long);
Linus Torvalds39c68542009-01-08 03:54:4745
Timo Hirvonen962554c2006-02-26 15:13:4646#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
Edgar Toernigb6829692005-04-30 16:51:0347#define DTYPE(de) ((de)->d_type)
48#else
Junio C Hamano0bdd79a2006-01-20 21:33:2049#undef DT_UNKNOWN
50#undef DT_DIR
51#undef DT_REG
52#undef DT_LNK
Edgar Toernigb6829692005-04-30 16:51:0353#define DT_UNKNOWN 0
54#define DT_DIR 1
55#define DT_REG 2
Junio C Hamanoa15c1c62005-05-13 00:16:0456#define DT_LNK 3
Edgar Toernigb6829692005-04-30 16:51:0357#define DTYPE(de) DT_UNKNOWN
58#endif
59
Martin Koegler40689ae2007-04-22 16:43:5660/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
61#define S_IFINVALID 0030000
62
Linus Torvaldse83c5162005-04-07 22:13:1363/*
Linus Torvalds9eec4792007-04-10 04:14:5864 * A "directory link" is a link to another git directory.
65 *
66 * The value 0160000 is not normally a valid mode, and
67 * also just happens to be S_IFDIR + S_IFLNK
68 *
69 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
70 * always having the same values everywhere. We should use
71 * our internal git values for these things, and then we can
72 * translate that to the OS-specific value. It just so
73 * happens that everybody shares the same bit representation
74 * in the UNIX world (and apparently wider too..)
75 */
Martin Waitz302b9282007-05-21 20:08:2876#define S_IFGITLINK 0160000
77#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
Linus Torvalds9eec4792007-04-10 04:14:5878
79/*
Kirill Smelkov72441af2014-04-06 21:46:2680 * Some mode bits are also used internally for computations.
81 *
82 * They *must* not overlap with any valid modes, and they *must* not be emitted
83 * to outside world - i.e. appear on disk or network. In other words, it's just
84 * temporary fields, which we internally use, but they have to stay in-house.
85 *
86 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
87 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
88 */
89
90/* used internally in tree-diff */
91#define S_DIFFTREE_IFXMIN_NEQ 0x80000000
92
93
94/*
Linus Torvalds2386d652005-07-14 01:46:2095 * Intensive research over the course of many years has shown that
96 * port 9418 is totally unused by anything else. Or
97 *
98 * Your search - "port 9418" - did not match any documents.
99 *
100 * as www.google.com puts it.
Linus Torvaldsba8a4972005-09-12 18:23:00101 *
102 * This port has been properly assigned for git use by IANA:
103 * git (Assigned-9418) [I06-050728-0001].
104 *
105 * git 9418/tcp git pack transfer service
106 * git 9418/udp git pack transfer service
107 *
108 * with Linus Torvalds <torvalds@osdl.org> as the point of
109 * contact. September 2005.
110 *
111 * See http://www.iana.org/assignments/port-numbers
Linus Torvalds2386d652005-07-14 01:46:20112 */
113#define DEFAULT_GIT_PORT 9418
114
115/*
Linus Torvaldse83c5162005-04-07 22:13:13116 * Basic data structures for the directory cache
Linus Torvaldse83c5162005-04-07 22:13:13117 */
118
119#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
120struct cache_header {
Thomas Gummerer7800c1e2013-08-18 19:41:51121 uint32_t hdr_signature;
122 uint32_t hdr_version;
123 uint32_t hdr_entries;
Linus Torvaldse83c5162005-04-07 22:13:13124};
125
Junio C Hamano9d227782012-04-04 16:12:43126#define INDEX_FORMAT_LB 2
127#define INDEX_FORMAT_UB 4
128
Linus Torvaldse83c5162005-04-07 22:13:13129/*
130 * The "cache_time" is just the low 32 bits of the
131 * time. It doesn't matter if it overflows - we only
132 * check it for equality in the 32 bits we save.
133 */
134struct cache_time {
Thomas Gummerer7800c1e2013-08-18 19:41:51135 uint32_t sec;
136 uint32_t nsec;
Linus Torvaldse83c5162005-04-07 22:13:13137};
138
Michael Haggertyc21d39d2013-06-20 08:37:50139struct stat_data {
140 struct cache_time sd_ctime;
141 struct cache_time sd_mtime;
142 unsigned int sd_dev;
143 unsigned int sd_ino;
144 unsigned int sd_uid;
145 unsigned int sd_gid;
146 unsigned int sd_size;
147};
148
Linus Torvaldse83c5162005-04-07 22:13:13149struct cache_entry {
Karsten Blees8b013782013-11-14 19:21:58150 struct hashmap_entry ent;
Michael Haggertyc21d39d2013-06-20 08:37:50151 struct stat_data ce_stat_data;
Linus Torvaldsccc4feb2005-04-15 17:44:27152 unsigned int ce_mode;
Linus Torvalds7a51ed62008-01-15 00:03:17153 unsigned int ce_flags;
Thomas Gummererb60e1882012-07-11 09:22:37154 unsigned int ce_namelen;
Nguyễn Thái Ngọc Duy5fc2fc82014-06-13 12:19:36155 unsigned int index; /* for link extension */
Linus Torvaldse83c5162005-04-07 22:13:13156 unsigned char sha1[20];
Junio C Hamano8f1d2e62006-01-07 09:33:54157 char name[FLEX_ARRAY]; /* more */
Linus Torvaldse83c5162005-04-07 22:13:13158};
159
Linus Torvalds95fd5bf2005-04-16 05:51:44160#define CE_STAGEMASK (0x3000)
Junio C Hamano16ce2e4c2008-08-17 06:02:08161#define CE_EXTENDED (0x4000)
Junio C Hamano5f730762006-02-09 05:15:24162#define CE_VALID (0x8000)
Junio C Hamanoaee46192005-04-16 15:33:23163#define CE_STAGESHIFT 12
Linus Torvalds95fd5bf2005-04-16 05:51:44164
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01165/*
Nguyễn Thái Ngọc Duyce51bf02014-06-13 12:19:25166 * Range 0xFFFF0FFF in ce_flags is divided into
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01167 * two parts: in-memory flags and on-disk ones.
168 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
169 * if you want to save a new flag, add it in
170 * CE_EXTENDED_FLAGS
171 *
172 * In-memory only flags
173 */
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16174#define CE_UPDATE (1 << 16)
175#define CE_REMOVE (1 << 17)
176#define CE_UPTODATE (1 << 18)
177#define CE_ADDED (1 << 19)
Linus Torvaldsa22c6372008-02-23 04:37:40178
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16179#define CE_HASHED (1 << 20)
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16180#define CE_WT_REMOVE (1 << 22) /* remove in work directory */
181#define CE_CONFLICTED (1 << 23)
Linus Torvalds7a51ed62008-01-15 00:03:17182
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16183#define CE_UNPACKED (1 << 24)
Nguyễn Thái Ngọc Duy2431afb2010-11-27 06:24:04184#define CE_NEW_SKIP_WORKTREE (1 << 25)
Junio C Hamanoda165f42010-01-07 22:59:54185
Nguyễn Thái Ngọc Duye721c152013-03-27 05:58:21186/* used to temporarily mark paths matched by pathspecs */
187#define CE_MATCHED (1 << 26)
188
Nguyễn Thái Ngọc Duy078a58e2014-06-13 12:19:39189#define CE_UPDATE_IN_BASE (1 << 27)
Nguyễn Thái Ngọc Duyb3c96fb2014-06-13 12:19:43190#define CE_STRIP_NAME (1 << 28)
Nguyễn Thái Ngọc Duy078a58e2014-06-13 12:19:39191
Linus Torvaldsd070e3a2008-02-23 04:39:21192/*
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01193 * Extended on-disk flags
194 */
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16195#define CE_INTENT_TO_ADD (1 << 29)
196#define CE_SKIP_WORKTREE (1 << 30)
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01197/* CE_EXTENDED2 is for future extension */
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16198#define CE_EXTENDED2 (1 << 31)
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01199
Nguyễn Thái Ngọc Duy44a36912009-08-20 13:46:57200#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01201
202/*
203 * Safeguard to avoid saving wrong flags:
204 * - CE_EXTENDED2 won't get saved until its semantic is known
205 * - Bits in 0x0000FFFF have been saved in ce_flags already
206 * - Bits in 0x003F0000 are currently in-memory flags
207 */
208#if CE_EXTENDED_FLAGS & 0x803FFFFF
209#error "CE_EXTENDED_FLAGS out of range"
210#endif
211
Nguyễn Thái Ngọc Duy64acde92013-07-14 08:35:25212struct pathspec;
213
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01214/*
Linus Torvaldseb7a2f12008-02-23 04:41:17215 * Copy the sha1 and stat state of a cache entry from one to
216 * another. But we never change the name, or the hash state!
217 */
René Scharfe20d142b2013-06-02 15:46:51218static inline void copy_cache_entry(struct cache_entry *dst,
219 const struct cache_entry *src)
Linus Torvaldseb7a2f12008-02-23 04:41:17220{
Karsten Blees419a5972013-11-14 19:22:27221 unsigned int state = dst->ce_flags & CE_HASHED;
Linus Torvaldseb7a2f12008-02-23 04:41:17222
223 /* Don't copy hash chain and name */
Karsten Blees8b013782013-11-14 19:21:58224 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
225 offsetof(struct cache_entry, name) -
226 offsetof(struct cache_entry, ce_stat_data));
Linus Torvaldseb7a2f12008-02-23 04:41:17227
228 /* Restore the hash state */
Karsten Blees419a5972013-11-14 19:22:27229 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
Linus Torvaldseb7a2f12008-02-23 04:41:17230}
231
Thomas Gummererb60e1882012-07-11 09:22:37232static inline unsigned create_ce_flags(unsigned stage)
Junio C Hamano7fec10b2008-01-19 07:42:00233{
Thomas Gummererb60e1882012-07-11 09:22:37234 return (stage << CE_STAGESHIFT);
Junio C Hamano7fec10b2008-01-19 07:42:00235}
236
Thomas Gummererb60e1882012-07-11 09:22:37237#define ce_namelen(ce) ((ce)->ce_namelen)
Junio C Hamanoaee46192005-04-16 15:33:23238#define ce_size(ce) cache_entry_size(ce_namelen(ce))
Linus Torvalds7a51ed62008-01-15 00:03:17239#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
Junio C Hamanoeadb5832008-01-19 07:45:24240#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
Nguyễn Thái Ngọc Duy44a36912009-08-20 13:46:57241#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
Junio C Hamanoeadb5832008-01-19 07:45:24242#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
Junio C Hamanoaee46192005-04-16 15:33:23243
Linus Torvaldse4479472005-04-17 05:26:31244#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
Kay Sievers8ae0a8c2005-05-05 12:38:25245static inline unsigned int create_ce_mode(unsigned int mode)
246{
Kay Sievers8ae0a8c2005-05-05 12:38:25247 if (S_ISLNK(mode))
Linus Torvalds7a51ed62008-01-15 00:03:17248 return S_IFLNK;
Martin Waitz302b9282007-05-21 20:08:28249 if (S_ISDIR(mode) || S_ISGITLINK(mode))
Linus Torvalds7a51ed62008-01-15 00:03:17250 return S_IFGITLINK;
251 return S_IFREG | ce_permissions(mode);
Kay Sievers8ae0a8c2005-05-05 12:38:25252}
René Scharfe20d142b2013-06-02 15:46:51253static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
254 unsigned int mode)
Junio C Hamano185c9752007-02-17 06:43:48255{
Johannes Sixt78a8d642007-03-02 21:11:30256 extern int trust_executable_bit, has_symlinks;
257 if (!has_symlinks && S_ISREG(mode) &&
Linus Torvalds7a51ed62008-01-15 00:03:17258 ce && S_ISLNK(ce->ce_mode))
Johannes Sixt78a8d642007-03-02 21:11:30259 return ce->ce_mode;
Junio C Hamano185c9752007-02-17 06:43:48260 if (!trust_executable_bit && S_ISREG(mode)) {
Linus Torvalds7a51ed62008-01-15 00:03:17261 if (ce && S_ISREG(ce->ce_mode))
Junio C Hamano185c9752007-02-17 06:43:48262 return ce->ce_mode;
263 return create_ce_mode(0666);
264 }
265 return create_ce_mode(mode);
266}
Junio C Hamanod6b8fc32008-01-31 09:17:48267static inline int ce_to_dtype(const struct cache_entry *ce)
268{
269 unsigned ce_mode = ntohl(ce->ce_mode);
270 if (S_ISREG(ce_mode))
271 return DT_REG;
272 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
273 return DT_DIR;
274 else if (S_ISLNK(ce_mode))
275 return DT_LNK;
276 else
277 return DT_UNKNOWN;
278}
René Scharfeb90d9b82010-10-04 10:53:11279static inline unsigned int canon_mode(unsigned int mode)
280{
281 if (S_ISREG(mode))
282 return S_IFREG | ce_permissions(mode);
283 if (S_ISLNK(mode))
284 return S_IFLNK;
285 if (S_ISDIR(mode))
286 return S_IFDIR;
287 return S_IFGITLINK;
288}
Linus Torvaldse4479472005-04-17 05:26:31289
René Scharfeee7825b2011-10-25 18:00:04290#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
Linus Torvaldsf5cabd12005-04-16 04:45:38291
Nguyễn Thái Ngọc Duye636a7b2014-06-13 12:19:27292#define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
293#define CE_ENTRY_CHANGED (1 << 1)
294#define CE_ENTRY_REMOVED (1 << 2)
295#define CE_ENTRY_ADDED (1 << 3)
Nguyễn Thái Ngọc Duy6c306a32014-06-13 12:19:29296#define RESOLVE_UNDO_CHANGED (1 << 4)
Nguyễn Thái Ngọc Duya5400ef2014-06-13 12:19:31297#define CACHE_TREE_CHANGED (1 << 5)
Nguyễn Thái Ngọc Duyc18b80a2014-06-13 12:19:44298#define SPLIT_INDEX_ORDERED (1 << 6)
Nguyễn Thái Ngọc Duye636a7b2014-06-13 12:19:27299
Nguyễn Thái Ngọc Duy5fc2fc82014-06-13 12:19:36300struct split_index;
Junio C Hamano228e94f2007-04-02 01:14:06301struct index_state {
302 struct cache_entry **cache;
Junio C Hamano9d227782012-04-04 16:12:43303 unsigned int version;
Junio C Hamano228e94f2007-04-02 01:14:06304 unsigned int cache_nr, cache_alloc, cache_changed;
Junio C Hamanocfc57892009-12-25 08:30:51305 struct string_list *resolve_undo;
Junio C Hamano228e94f2007-04-02 01:14:06306 struct cache_tree *cache_tree;
Nguyễn Thái Ngọc Duy5fc2fc82014-06-13 12:19:36307 struct split_index *split_index;
Kjetil Barvikfba2f382009-02-19 20:08:29308 struct cache_time timestamp;
Junio C Hamano913e0e92008-08-23 19:57:30309 unsigned name_hash_initialized : 1,
310 initialized : 1;
Karsten Blees8b013782013-11-14 19:21:58311 struct hashmap name_hash;
Karsten Bleese05881a2013-11-14 19:20:58312 struct hashmap dir_hash;
Yiannis Marangos426ddee2014-04-10 18:31:21313 unsigned char sha1[20];
Junio C Hamano228e94f2007-04-02 01:14:06314};
315
316extern struct index_state the_index;
317
Linus Torvalds96872bc2008-03-21 20:16:24318/* Name hashing */
319extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
Karsten Blees20926782013-02-27 23:57:48320extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
321extern void free_name_hash(struct index_state *istate);
Linus Torvalds96872bc2008-03-21 20:16:24322
323
Junio C Hamano4aab5b42007-04-02 06:26:07324#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
Junio C Hamano228e94f2007-04-02 01:14:06325#define active_cache (the_index.cache)
326#define active_nr (the_index.cache_nr)
327#define active_alloc (the_index.cache_alloc)
328#define active_cache_changed (the_index.cache_changed)
329#define active_cache_tree (the_index.cache_tree)
Linus Torvaldse83c5162005-04-07 22:13:13330
Junio C Hamano4aab5b42007-04-02 06:26:07331#define read_cache() read_index(&the_index)
332#define read_cache_from(path) read_index_from(&the_index, (path))
Linus Torvalds671c9b72008-11-14 00:36:30333#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
Junio C Hamanofa7b3c22008-11-12 19:52:35334#define is_cache_unborn() is_index_unborn(&the_index)
Miklos Vajnae46bbcf2008-06-27 16:21:58335#define read_cache_unmerged() read_index_unmerged(&the_index)
Junio C Hamano4aab5b42007-04-02 06:26:07336#define discard_cache() discard_index(&the_index)
Daniel Barkalow94a57282008-02-07 16:40:13337#define unmerged_cache() unmerged_index(&the_index)
Junio C Hamano4aab5b42007-04-02 06:26:07338#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
339#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
Petr Baudis81dc2302008-07-21 00:25:56340#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
Junio C Hamano4aab5b42007-04-02 06:26:07341#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
342#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
Junio C Hamano38ed1d82008-05-21 19:04:34343#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
344#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
Matthieu Moy3deffc52009-08-21 08:57:59345#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
Junio C Hamano4bd5b7d2007-11-10 08:15:03346#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
347#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
Eric Sunshinedb5360f2013-09-17 07:06:14348#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
349#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
Jeff King98fa4732008-10-16 15:07:26350#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
Junio C Hamanocfc57892009-12-25 08:30:51351#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
Junio C Hamano8aa38562009-12-25 21:40:02352#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
Junio C Hamano4421a822009-12-25 19:57:11353#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
Lukas Fleischerff366822013-04-13 13:28:31354#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
Junio C Hamano4aab5b42007-04-02 06:26:07355#endif
Linus Torvaldse83c5162005-04-07 22:13:13356
Junio C Hamanoedaec3f2007-02-28 19:45:56357enum object_type {
358 OBJ_BAD = -1,
359 OBJ_NONE = 0,
360 OBJ_COMMIT = 1,
361 OBJ_TREE = 2,
362 OBJ_BLOB = 3,
363 OBJ_TAG = 4,
364 /* 5 for future expansion */
365 OBJ_OFS_DELTA = 6,
366 OBJ_REF_DELTA = 7,
Martin Koegler355885d2008-02-25 21:46:04367 OBJ_ANY,
Gary V. Vaughan4b055482010-05-14 09:31:35368 OBJ_MAX
Junio C Hamanoedaec3f2007-02-28 19:45:56369};
370
Junio C Hamanob45563a2007-12-01 06:22:38371static inline enum object_type object_type(unsigned int mode)
372{
373 return S_ISDIR(mode) ? OBJ_TREE :
374 S_ISGITLINK(mode) ? OBJ_COMMIT :
375 OBJ_BLOB;
376}
377
Jeff King2163e5d2013-03-08 09:29:08378/* Double-check local_repo_env below if you add to this list. */
Junio C Hamano8ac069a2005-05-10 05:57:58379#define GIT_DIR_ENVIRONMENT "GIT_DIR"
Josh Tripletta1bea2c2011-07-05 17:54:44380#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
Matthias Lederhofer892c41b2007-06-06 07:10:42381#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
Jeff Kinga6f7f9a2013-03-08 09:30:25382#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
Junio C Hamano8ac069a2005-05-10 05:57:58383#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
Junio C Hamanod19938a2005-05-10 00:57:56384#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
Linus Torvaldsbb233d62005-04-21 17:55:18385#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
Junio C Hamano5da5c8f2005-07-30 07:58:28386#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
Nguyễn Thái Ngọc Duy069c0532013-12-05 13:02:45387#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
Junio C Hamanod4ebc362006-12-19 09:28:15388#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
389#define CONFIG_ENVIRONMENT "GIT_CONFIG"
Jeff King2b64fc82010-08-23 19:16:00390#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
Junio C Hamanod4ebc362006-12-19 09:28:15391#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
David Reiss0454dd92008-05-20 06:49:26392#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
Christian Couder6476b382009-11-18 06:50:58393#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
Junio C Hamanod0bfd022007-04-12 08:07:32394#define GITATTRIBUTES_FILE ".gitattributes"
395#define INFOATTRIBUTES_FILE "info/attributes"
Junio C Hamanof48fd682007-04-14 15:54:37396#define ATTRIBUTE_MACRO_PREFIX "[attr]"
Johannes Schindelina97a7462009-10-09 10:21:57397#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
398#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
Thomas Rast894a9d32010-03-12 17:04:26399#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
Thomas Rast6956f852010-03-12 17:04:32400#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
401#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
Jeff King823ab402012-12-19 22:37:30402#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
Nguyễn Thái Ngọc Duybd30c2e2013-07-14 08:36:08403#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
404#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
Nguyễn Thái Ngọc Duy93d93532013-07-14 08:36:09405#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
Linus Torvaldsbb233d62005-04-21 17:55:18406
Giuseppe Bilotta48a7c1c2010-02-24 23:34:14407/*
Jeff King2cd83d12013-03-08 09:32:22408 * This environment variable is expected to contain a boolean indicating
409 * whether we should or should not treat:
410 *
411 * GIT_DIR=foo.git git ...
412 *
413 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
414 * of this, but we use it internally to communicate to sub-processes that we
415 * are in a bare repo. If not set, defaults to true.
Giuseppe Bilotta48a7c1c2010-02-24 23:34:14416 */
Jeff King2cd83d12013-03-08 09:32:22417#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
418
419/*
Jeff King2163e5d2013-03-08 09:29:08420 * Repository-local GIT_* environment variables; these will be cleared
421 * when git spawns a sub-process that runs inside another repository.
422 * The array is NULL-terminated, which makes it easy to pass in the "env"
423 * parameter of a run-command invocation, or to do a simple walk.
Giuseppe Bilotta48a7c1c2010-02-24 23:34:14424 */
Jeff King2163e5d2013-03-08 09:29:08425extern const char * const local_repo_env[];
Giuseppe Bilotta48a7c1c2010-02-24 23:34:14426
Junio C Hamano7d1864c2007-01-07 10:00:28427extern int is_bare_repository_cfg;
428extern int is_bare_repository(void);
Johannes Schindelin68025632007-01-20 02:09:34429extern int is_inside_git_dir(void);
Johannes Schindeline90fdc32007-08-01 00:30:14430extern char *git_work_tree_cfg;
Matthias Lederhofer892c41b2007-06-06 07:10:42431extern int is_inside_work_tree(void);
Pierre Habouzitc5fba162006-08-23 10:39:11432extern const char *get_git_dir(void);
Jeff Kingb3256eb2012-02-02 21:59:13433extern int is_git_directory(const char *path);
Junio C Hamano8ac069a2005-05-10 05:57:58434extern char *get_object_directory(void);
Junio C Hamano8ac069a2005-05-10 05:57:58435extern char *get_index_file(void);
Junio C Hamano5da5c8f2005-07-30 07:58:28436extern char *get_graft_file(void);
Johannes Schindelind7ac12b2007-08-01 00:29:38437extern int set_git_dir(const char *path);
Josh Tripletta1bea2c2011-07-05 17:54:44438extern const char *get_git_namespace(void);
439extern const char *strip_namespace(const char *namespaced_ref);
Johannes Schindeline90fdc32007-08-01 00:30:14440extern const char *get_git_work_tree(void);
Junio C Hamano13d6ec92011-08-22 21:04:56441extern const char *read_gitfile(const char *path);
Fredrik Gustafssonabc06822011-08-15 21:17:46442extern const char *resolve_gitdir(const char *suspect);
Daniel Barkalow19757d82008-04-27 17:39:21443extern void set_git_work_tree(const char *tree);
Junio C Hamano8ac069a2005-05-10 05:57:58444
445#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
Linus Torvaldsbb233d62005-04-21 17:55:18446
Junio C Hamano6b5ee132005-09-21 07:00:47447extern const char **get_pathspec(const char *prefix, const char **pathspec);
Mike Hommey59f0f2f2007-11-03 11:23:11448extern void setup_work_tree(void);
Junio C Hamano4ca06602005-11-26 07:14:15449extern const char *setup_git_directory_gently(int *);
Linus Torvaldsd288a702005-08-17 01:06:34450extern const char *setup_git_directory(void);
Nguyễn Thái Ngọc Duyedc54fb2010-11-11 14:08:03451extern char *prefix_path(const char *prefix, int len, const char *path);
Nguyễn Thái Ngọc Duy645a29c2013-07-14 08:36:03452extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
Junio C Hamano4ca06602005-11-26 07:14:15453extern const char *prefix_filename(const char *prefix, int len, const char *path);
Junio C Hamanoc6e8c802009-10-18 07:27:24454extern int check_filename(const char *prefix, const char *name);
Matthieu Moy023e37c2012-06-18 18:18:21455extern void verify_filename(const char *prefix,
456 const char *name,
457 int diagnose_misspelt_rev);
Junio C Hamanoea92f412006-04-26 22:09:27458extern void verify_non_filename(const char *prefix, const char *name);
Jeff King546e0fd2012-06-21 18:09:50459extern int path_inside_repo(const char *prefix, const char *path);
Linus Torvaldsd288a702005-08-17 01:06:34460
Daniel Barkalowf225aeb2008-04-27 17:39:27461#define INIT_DB_QUIET 0x0001
462
Nguyễn Thái Ngọc Duyb57fb802011-03-19 15:16:56463extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
Daniel Barkalowf225aeb2008-04-27 17:39:27464extern int init_db(const char *template_dir, unsigned int flags);
465
Thomas Rast1d999dd2013-07-16 09:27:36466extern void sanitize_stdfds(void);
Nguyễn Thái Ngọc Duyde0957c2014-02-08 07:08:51467extern int daemonize(void);
Thomas Rast1d999dd2013-07-16 09:27:36468
Linus Torvaldse83c5162005-04-07 22:13:13469#define alloc_nr(x) (((x)+16)*3/2)
470
Jeff King6815e562007-06-11 13:39:44471/*
472 * Realloc the buffer pointed at by variable 'x' so that it can hold
473 * at least 'nr' entries; the number of entries currently allocated
474 * is 'alloc', using the standard growing factor alloc_nr() macro.
475 *
Jonathan Nieder01f6fd42010-10-08 16:46:59476 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
Jeff King6815e562007-06-11 13:39:44477 */
478#define ALLOC_GROW(x, nr, alloc) \
479 do { \
Jeff Kingc927e6c2007-06-16 22:37:39480 if ((nr) > alloc) { \
Junio C Hamano4234a762007-06-12 05:10:55481 if (alloc_nr(alloc) < (nr)) \
482 alloc = (nr); \
483 else \
484 alloc = alloc_nr(alloc); \
René Scharfe2756ca42014-09-16 18:56:57485 REALLOC_ARRAY(x, alloc); \
Jeff King6815e562007-06-11 13:39:44486 } \
Jonathan Nieder98746062010-08-12 22:11:15487 } while (0)
Jeff King6815e562007-06-11 13:39:44488
Linus Torvalds734aab72005-04-09 16:48:20489/* Initialize and use the cache information */
Nguyễn Thái Ngọc Duy03b86642014-06-13 12:19:23490struct lock_file;
Junio C Hamano4aab5b42007-04-02 06:26:07491extern int read_index(struct index_state *);
Nguyễn Thái Ngọc Duy5ab2a2d2013-07-14 08:35:49492extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
Nguyễn Thái Ngọc Duy3e52f702014-06-13 12:19:51493extern int do_read_index(struct index_state *istate, const char *path,
494 int must_exist); /* for testting only! */
Junio C Hamano4aab5b42007-04-02 06:26:07495extern int read_index_from(struct index_state *, const char *path);
Junio C Hamanofa7b3c22008-11-12 19:52:35496extern int is_index_unborn(struct index_state *);
Miklos Vajnae46bbcf2008-06-27 16:21:58497extern int read_index_unmerged(struct index_state *);
Nguyễn Thái Ngọc Duy03b86642014-06-13 12:19:23498#define COMMIT_LOCK (1 << 0)
499#define CLOSE_LOCK (1 << 1)
500extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
Junio C Hamano4aab5b42007-04-02 06:26:07501extern int discard_index(struct index_state *);
Linus Torvaldsd1f128b2008-03-06 20:46:09502extern int unmerged_index(const struct index_state *);
Linus Torvalds8dcf39c2006-05-18 19:07:31503extern int verify_path(const char *path);
Eric Sunshinedb5360f2013-09-17 07:06:14504extern struct cache_entry *index_dir_exists(struct index_state *istate, const char *name, int namelen);
505extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
Linus Torvaldsd1f128b2008-03-06 20:46:09506extern int index_name_pos(const struct index_state *, const char *name, int namelen);
Junio C Hamano192268c2005-05-08 04:55:21507#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
508#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
Junio C Hamanob1557252005-06-25 09:25:29509#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
Junio C Hamanoaf3785d2007-08-09 20:42:50510#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
Junio C Hamano39425812008-08-21 08:44:53511#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
Nguyễn Thái Ngọc Duyce7c6142014-06-13 12:19:42512#define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
Junio C Hamano4aab5b42007-04-02 06:26:07513extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
Petr Baudis81dc2302008-07-21 00:25:56514extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
Junio C Hamano4aab5b42007-04-02 06:26:07515extern int remove_index_entry_at(struct index_state *, int pos);
Kjetil Barvik36419c82009-02-18 22:18:03516extern void remove_marked_cache_entries(struct index_state *istate);
Junio C Hamano4aab5b42007-04-02 06:26:07517extern int remove_file_from_index(struct index_state *, const char *path);
Junio C Hamano38ed1d82008-05-21 19:04:34518#define ADD_CACHE_VERBOSE 1
519#define ADD_CACHE_PRETEND 2
Junio C Hamano01665922008-05-25 21:03:50520#define ADD_CACHE_IGNORE_ERRORS 4
Junio C Hamano041aee32008-07-21 08:24:17521#define ADD_CACHE_IGNORE_REMOVAL 8
Junio C Hamano39425812008-08-21 08:44:53522#define ADD_CACHE_INTENT 16
Junio C Hamano38ed1d82008-05-21 19:04:34523extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
524extern int add_file_to_index(struct index_state *, const char *path, int flags);
Brad King25762722014-01-27 14:45:08525extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
Nguyễn Thái Ngọc Duy9c5e6c82013-07-09 15:29:00526extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
Nguyễn Thái Ngọc Duyb4b313f2014-02-04 02:20:09527extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
Jeff King98fa4732008-10-16 15:07:26528extern int index_name_is_other(const struct index_state *, const char *, int);
Lukas Fleischerff366822013-04-13 13:28:31529extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
Junio C Hamano4bd5b7d2007-11-10 08:15:03530
531/* do stat comparison even if CE_VALID is true */
532#define CE_MATCH_IGNORE_VALID 01
533/* do not check the contents but report dirty on racily-clean entries */
Nguyễn Thái Ngọc Duy56cac482009-12-14 11:43:58534#define CE_MATCH_RACY_IS_DIRTY 02
535/* do stat comparison even if CE_SKIP_WORKTREE is true */
536#define CE_MATCH_IGNORE_SKIP_WORKTREE 04
Brad King2e2e7ec2014-01-27 14:45:07537/* ignore non-existent files during stat update */
538#define CE_MATCH_IGNORE_MISSING 0x08
Brad King25762722014-01-27 14:45:08539/* enable stat refresh */
540#define CE_MATCH_REFRESH 0x10
René Scharfe21a6b9f2013-06-02 15:46:52541extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
542extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
Junio C Hamano4bd5b7d2007-11-10 08:15:03543
Junio C Hamanoc4ce46f2011-05-08 08:47:33544#define HASH_WRITE_OBJECT 1
545#define HASH_FORMAT_CHECK 2
546extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
547extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
Michael Haggertyc21d39d2013-06-20 08:37:50548
549/*
550 * Record to sd the data from st that we use to check whether a file
551 * might have changed.
552 */
553extern void fill_stat_data(struct stat_data *sd, struct stat *st);
554
555/*
556 * Return 0 if st is consistent with a file not having been changed
557 * since sd was filled. If there are differences, return a
558 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
559 * INODE_CHANGED, and DATA_CHANGED.
560 */
561extern int match_stat_data(const struct stat_data *sd, struct stat *st);
562
Junio C Hamano415e96c2005-05-15 21:23:12563extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
564
Linus Torvalds405e5b22006-05-19 16:56:35565#define REFRESH_REALLY 0x0001 /* ignore_valid */
566#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
567#define REFRESH_QUIET 0x0004 /* be quiet about it */
568#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
Junio C Hamano3f1b7b62008-07-20 06:25:00569#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
Matthieu Moy43673fd2009-08-21 08:57:58570#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
Nguyễn Thái Ngọc Duy9b2d6142013-07-14 08:35:54571extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
Linus Torvalds405e5b22006-05-19 16:56:35572
Junio C Hamanoccdc4ec2011-03-21 17:16:10573extern void update_index_if_able(struct index_state *, struct lock_file *);
Junio C Hamano30ca07a2007-04-01 06:09:02574
575extern int hold_locked_index(struct lock_file *, int);
Junio C Hamano5e7f56a2007-04-01 06:27:41576extern void set_alternate_index_output(const char *);
Michael Haggerty697cc8e2014-10-01 10:28:42577
Miklos Vajnaeca35a22008-10-26 02:33:56578extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
Linus Torvalds734aab72005-04-09 16:48:20579
Junio C Hamano2ae1c532006-02-27 22:47:45580/* Environment bits from configuration mechanism */
Linus Torvalds17712992005-10-10 23:31:08581extern int trust_executable_bit;
Alex Riesen1ce47902008-07-28 06:31:28582extern int trust_ctime;
Robin Rosenbergc08e4d52013-01-22 07:49:22583extern int check_stat;
Junio C Hamano9378c162007-06-24 22:11:24584extern int quote_path_fully;
Johannes Sixt78a8d642007-03-02 21:11:30585extern int has_symlinks;
Linus Torvaldsdce96482010-10-28 18:28:04586extern int minimum_abbrev, default_abbrev;
Linus Torvalds0a9b88b2008-03-21 23:52:46587extern int ignore_case;
Junio C Hamano5f730762006-02-09 05:15:24588extern int assume_unchanged;
Junio C Hamano9f0bb902006-05-02 07:40:24589extern int prefer_symlink_refs;
Shawn Pearce6de08ae2006-05-17 09:55:40590extern int log_all_ref_updates;
Junio C Hamano2f8acdb2006-03-21 02:45:47591extern int warn_ambiguous_refs;
Jeff King25fba782013-07-12 06:20:05592extern int warn_on_object_refname_ambiguity;
Johannes Schindelin457f06d2005-12-22 22:13:56593extern int shared_repository;
Junio C Hamano2ae1c532006-02-27 22:47:45594extern const char *apply_default_whitespace;
Giuseppe Bilotta86c91f92009-08-04 11:16:49595extern const char *apply_default_ignorewhitespace;
Junio C Hamano64589a02011-10-06 18:22:24596extern const char *git_attributes_file;
Joachim B Haga12f6c302006-07-03 20:11:47597extern int zlib_compression_level;
Dana How960ccca2007-05-09 20:56:50598extern int core_compression_level;
599extern int core_compression_seen;
Shawn O. Pearce60bb8b12006-12-23 07:34:28600extern size_t packed_git_window_size;
Shawn O. Pearce77ccc5b2006-12-23 07:33:35601extern size_t packed_git_limit;
Shawn O. Pearce18bdec12007-03-19 05:14:37602extern size_t delta_base_cache_limit;
Junio C Hamano15366282011-04-05 17:44:11603extern unsigned long big_file_threshold;
Junio C Hamano568508e2011-10-28 21:48:40604extern unsigned long pack_size_limit_cfg;
Michael Haggertyafc711b2014-02-18 11:24:55605
606/*
607 * Do replace refs need to be checked this run? This variable is
608 * initialized to true unless --no-replace-object is used or
609 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
610 * commands that do not want replace references to be active. As an
611 * optimization it is also set to false if replace references have
612 * been sought but there were none.
613 */
614extern int check_replace_refs;
615
Linus Torvaldsaafe9fb2008-06-18 22:18:44616extern int fsync_object_files;
Linus Torvalds671c9b72008-11-14 00:36:30617extern int core_preload_index;
Nguyễn Thái Ngọc Duy08aefc92009-08-20 13:47:08618extern int core_apply_sparse_checkout;
Torsten Bögershausen76759c72012-07-08 13:50:25619extern int precomposed_unicode;
Linus Torvalds17712992005-10-10 23:31:08620
Junio C Hamanoeff80a92013-01-16 19:18:48621/*
622 * The character that begins a commented line in user-editable file
623 * that is subject to stripspace.
624 */
625extern char comment_line_char;
Nguyễn Thái Ngọc Duy84c9dc22014-05-17 01:52:23626extern int auto_comment_line_char;
Junio C Hamanoeff80a92013-01-16 19:18:48627
Jay Soffian9ed36cf2008-02-19 16:24:37628enum branch_track {
Alex Riesen9188ed82008-08-21 17:23:20629 BRANCH_TRACK_UNSPECIFIED = -1,
Jay Soffian9ed36cf2008-02-19 16:24:37630 BRANCH_TRACK_NEVER = 0,
631 BRANCH_TRACK_REMOTE,
632 BRANCH_TRACK_ALWAYS,
633 BRANCH_TRACK_EXPLICIT,
Gary V. Vaughan4b055482010-05-14 09:31:35634 BRANCH_TRACK_OVERRIDE
Jay Soffian9ed36cf2008-02-19 16:24:37635};
636
Dustin Sallingsc998ae92008-05-10 22:36:29637enum rebase_setup_type {
638 AUTOREBASE_NEVER = 0,
639 AUTOREBASE_LOCAL,
640 AUTOREBASE_REMOTE,
Gary V. Vaughan4b055482010-05-14 09:31:35641 AUTOREBASE_ALWAYS
Dustin Sallingsc998ae92008-05-10 22:36:29642};
643
Finn Arne Gangstad52153742009-03-16 15:42:51644enum push_default_type {
Finn Arne Gangstad52153742009-03-16 15:42:51645 PUSH_DEFAULT_NOTHING = 0,
646 PUSH_DEFAULT_MATCHING,
Matthieu Moyb55e67752012-04-24 07:50:03647 PUSH_DEFAULT_SIMPLE,
Johan Herland53c40312011-02-16 00:54:24648 PUSH_DEFAULT_UPSTREAM,
Christopher Tiwaldf25950f2012-03-20 04:31:33649 PUSH_DEFAULT_CURRENT,
650 PUSH_DEFAULT_UNSPECIFIED
Finn Arne Gangstad52153742009-03-16 15:42:51651};
652
Jay Soffian9ed36cf2008-02-19 16:24:37653extern enum branch_track git_branch_track;
Dustin Sallingsc998ae92008-05-10 22:36:29654extern enum rebase_setup_type autorebase;
Finn Arne Gangstad52153742009-03-16 15:42:51655extern enum push_default_type push_default;
Jay Soffian9ed36cf2008-02-19 16:24:37656
Johannes Schindelin348df162009-04-27 22:32:25657enum object_creation_mode {
658 OBJECT_CREATION_USES_HARDLINKS = 0,
Gary V. Vaughan4b055482010-05-14 09:31:35659 OBJECT_CREATION_USES_RENAMES = 1
Johannes Schindelin348df162009-04-27 22:32:25660};
661
662extern enum object_creation_mode object_creation_mode;
Johannes Schindelinbe66a6c2009-04-25 09:57:14663
Johannes Schindelina97a7462009-10-09 10:21:57664extern char *notes_ref_name;
665
Johannes Schindelin7f3140c2009-07-23 15:33:49666extern int grafts_replace_parents;
667
Junio C Hamanoab9cb762005-11-25 23:59:09668#define GIT_REPO_VERSION 0
669extern int repository_format_version;
670extern int check_repository_format(void);
671
Linus Torvalds734aab72005-04-09 16:48:20672#define MTIME_CHANGED 0x0001
673#define CTIME_CHANGED 0x0002
674#define OWNER_CHANGED 0x0004
675#define MODE_CHANGED 0x0008
676#define INODE_CHANGED 0x0010
677#define DATA_CHANGED 0x0020
Kay Sievers8ae0a8c2005-05-05 12:38:25678#define TYPE_CHANGED 0x0040
Linus Torvaldse83c5162005-04-07 22:13:13679
Alex Riesen108bebe2008-10-26 21:59:13680extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
681 __attribute__((format (printf, 3, 4)));
Alex Riesenfe2d7772008-10-27 09:22:21682extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
683 __attribute__((format (printf, 3, 4)));
Alex Riesenaba13e72008-10-27 10:17:51684extern char *git_pathdup(const char *fmt, ...)
685 __attribute__((format (printf, 1, 2)));
Huynh Khoi Nguyen Nguyen21cf3222012-06-22 09:03:23686extern char *mkpathdup(const char *fmt, ...)
687 __attribute__((format (printf, 1, 2)));
Alex Riesen108bebe2008-10-26 21:59:13688
Linus Torvaldse83c5162005-04-07 22:13:13689/* Return a statically allocated filename matching the sha1 signature */
Timo Sirainen4ec99bf2005-08-09 15:30:22690extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
691extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
Heiko Voigt0bad6112010-07-07 13:39:11692extern char *git_path_submodule(const char *path, const char *fmt, ...)
693 __attribute__((format (printf, 2, 3)));
694
Michael Haggertyd40d5352014-02-21 16:32:06695/*
696 * Return the name of the file in the local object database that would
697 * be used to store a loose object with the specified sha1. The
698 * return value is a pointer to a statically allocated buffer that is
699 * overwritten each time the function is called.
700 */
Michael Haggerty30d6c6e2014-02-21 16:32:05701extern const char *sha1_file_name(const unsigned char *sha1);
Michael Haggertyd40d5352014-02-21 16:32:06702
703/*
704 * Return the name of the (local) packfile with the specified sha1 in
705 * its name. The return value is a pointer to memory that is
706 * overwritten each time this function is called.
707 */
barkalow@iabervon.orgbf592c52005-08-01 00:53:44708extern char *sha1_pack_name(const unsigned char *sha1);
Michael Haggertyd40d5352014-02-21 16:32:06709
710/*
711 * Return the name of the (local) pack index file with the specified
712 * sha1 in its name. The return value is a pointer to memory that is
713 * overwritten each time this function is called.
714 */
barkalow@iabervon.orgbf592c52005-08-01 00:53:44715extern char *sha1_pack_index_name(const unsigned char *sha1);
Michael Haggertyd40d5352014-02-21 16:32:06716
Junio C Hamano013f2762005-10-11 22:22:48717extern const char *find_unique_abbrev(const unsigned char *sha1, int);
Junio C Hamano88cd6212005-09-30 21:02:47718extern const unsigned char null_sha1[20];
Ingo Molnar1a812f32011-04-28 10:19:02719
David Rientjesa89fccd2006-08-17 18:54:57720static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
721{
Ingo Molnar1a812f32011-04-28 10:19:02722 int i;
723
724 for (i = 0; i < 20; i++, sha1++, sha2++) {
725 if (*sha1 != *sha2)
726 return *sha1 - *sha2;
727 }
728
729 return 0;
David Rientjesa89fccd2006-08-17 18:54:57730}
Ingo Molnar1a812f32011-04-28 10:19:02731
732static inline int is_null_sha1(const unsigned char *sha1)
733{
734 return !hashcmp(sha1, null_sha1);
735}
736
Shawn Pearcee7024962006-08-23 06:49:00737static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
738{
739 memcpy(sha_dst, sha_src, 20);
740}
Junio C Hamanoa8e0d162006-08-23 20:57:23741static inline void hashclr(unsigned char *hash)
742{
743 memset(hash, 0, 20);
744}
Linus Torvaldse83c5162005-04-07 22:13:13745
Jeff King14d9c572008-11-12 08:17:52746#define EMPTY_TREE_SHA1_HEX \
747 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
Jonathan Niederdab0d412011-02-07 08:17:27748#define EMPTY_TREE_SHA1_BIN_LITERAL \
Jeff King14d9c572008-11-12 08:17:52749 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
750 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
Jonathan Niederdab0d412011-02-07 08:17:27751#define EMPTY_TREE_SHA1_BIN \
752 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
Jeff King14d9c572008-11-12 08:17:52753
Jeff Kingf8582ca2012-03-22 18:53:39754#define EMPTY_BLOB_SHA1_HEX \
755 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
756#define EMPTY_BLOB_SHA1_BIN_LITERAL \
757 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
758 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
759#define EMPTY_BLOB_SHA1_BIN \
760 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
761
762static inline int is_empty_blob_sha1(const unsigned char *sha1)
763{
764 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
765}
766
Holger Eitzenbergerf2db68e2005-08-04 20:43:03767int git_mkstemp(char *path, size_t n, const char *template);
768
David Aguilar003b33a2009-05-31 08:35:52769int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
770
Matthieu Moyb862b612010-02-22 22:32:13771/* set default permissions by passing mode arguments to open(2) */
772int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
773int git_mkstemp_mode(char *pattern, int mode);
774
Heikki Orsila06cbe852008-04-16 08:34:24775/*
776 * NOTE NOTE NOTE!!
777 *
778 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
779 * not be changed. Old repositories have core.sharedrepository written in
780 * numeric format, and therefore these values are preserved for compatibility
781 * reasons.
782 */
Junio C Hamano94df2502006-06-10 06:09:49783enum sharedrepo {
Heikki Orsila06cbe852008-04-16 08:34:24784 PERM_UMASK = 0,
785 OLD_PERM_GROUP = 1,
786 OLD_PERM_EVERYBODY = 2,
787 PERM_GROUP = 0660,
Gary V. Vaughan4b055482010-05-14 09:31:35788 PERM_EVERYBODY = 0664
Junio C Hamano94df2502006-06-10 06:09:49789};
790int git_config_perm(const char *var, const char *value);
Torsten Bögershausen3a429d32013-03-30 09:53:32791int adjust_shared_perm(const char *path);
Michael Haggerty0be05212014-01-06 13:45:25792
793/*
794 * Create the directory containing the named path, using care to be
795 * somewhat safe against races. Return one of the scld_error values
796 * to indicate success/failure.
Michael Haggerty18d37e82014-01-06 13:45:27797 *
798 * SCLD_VANISHED indicates that one of the ancestor directories of the
799 * path existed at one point during the function call and then
800 * suddenly vanished, probably because another process pruned the
801 * directory while we were working. To be robust against this kind of
802 * race, callers might want to try invoking the function again when it
803 * returns SCLD_VANISHED.
Michael Haggerty0be05212014-01-06 13:45:25804 */
805enum scld_error {
806 SCLD_OK = 0,
807 SCLD_FAILED = -1,
808 SCLD_PERMS = -2,
Michael Haggerty18d37e82014-01-06 13:45:27809 SCLD_EXISTS = -3,
810 SCLD_VANISHED = -4
Michael Haggerty0be05212014-01-06 13:45:25811};
812enum scld_error safe_create_leading_directories(char *path);
813enum scld_error safe_create_leading_directories_const(const char *path);
814
Junio C Hamano90a64642011-03-11 00:02:50815int mkdir_in_gitdir(const char *path);
Huynh Khoi Nguyen Nguyen21cf3222012-06-22 09:03:23816extern void home_config_paths(char **global, char **xdg, char *file);
Matthieu Moy395de252009-11-17 17:24:25817extern char *expand_user_path(const char *path);
Erik Faye-Lund1c64b482011-10-04 20:02:00818const char *enter_repo(const char *path, int strict);
Johannes Schindeline5392c52007-08-01 00:28:59819static inline int is_absolute_path(const char *path)
820{
Theo Niessink88135202011-05-27 16:00:38821 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
Johannes Schindeline5392c52007-08-01 00:28:59822}
Junio C Hamano90b4a712008-09-09 08:27:07823int is_directory(const char *);
Carlos Martín Nietoe2a57aa2011-03-17 11:26:46824const char *real_path(const char *path);
Michael Haggertye3e46cd2012-10-28 16:16:22825const char *real_path_if_valid(const char *path);
Carlos Martín Nietoe2a57aa2011-03-17 11:26:46826const char *absolute_path(const char *path);
Jiang Xin41894ae2013-10-14 02:29:40827const char *remove_leading_path(const char *in, const char *prefix);
Jiang Xine02ca722013-06-25 15:53:43828const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
Nguyễn Thái Ngọc Duy645a29c2013-07-14 08:36:03829int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
Johannes Sixtf3cad0a2009-02-07 15:08:28830int normalize_path_copy(char *dst, const char *src);
Michael Haggerty31171d92012-10-28 16:16:24831int longest_ancestor_length(const char *path, struct string_list *prefixes);
Johannes Schindelin4fcc86b2009-02-19 19:10:49832char *strip_path_suffix(const char *path, const char *suffix);
Shawn O. Pearce34b6cb82009-11-09 19:26:43833int daemon_avoid_alias(const char *path);
Junio C Hamanob2cb9422005-07-06 08:11:52834
Junio C Hamanoe1111ce2011-05-15 19:54:53835/* object replacement */
Christian Couderffe68cf2013-12-11 07:46:04836#define LOOKUP_REPLACE_OBJECT 1
Junio C Hamano5bf29b92011-05-15 19:54:54837extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
Christian Couderf5552ae2009-01-23 09:07:01838static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
839{
Christian Couderffe68cf2013-12-11 07:46:04840 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
Christian Couderf5552ae2009-01-23 09:07:01841}
Michael Haggerty1f91e792014-02-28 16:29:16842
843/*
844 * This internal function is only declared here for the benefit of
845 * lookup_replace_object(). Please do not call it directly.
846 */
Junio C Hamanoe1111ce2011-05-15 19:54:53847extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
Michael Haggerty1f91e792014-02-28 16:29:16848
849/*
850 * If object sha1 should be replaced, return the replacement object's
851 * name (replaced recursively, if necessary). The return value is
852 * either sha1 or a pointer to a permanently-allocated value. When
853 * object replacement is suppressed, always return sha1.
854 */
Junio C Hamanoe1111ce2011-05-15 19:54:53855static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
856{
Michael Haggertyafc711b2014-02-18 11:24:55857 if (!check_replace_refs)
Junio C Hamanoe1111ce2011-05-15 19:54:53858 return sha1;
859 return do_lookup_replace_object(sha1);
860}
Michael Haggerty1f91e792014-02-28 16:29:16861
Christian Couderbf93eea2013-12-11 07:46:06862static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
863{
864 if (!(flag & LOOKUP_REPLACE_OBJECT))
865 return sha1;
866 return lookup_replace_object(sha1);
867}
Junio C Hamanoe1111ce2011-05-15 19:54:53868
Linus Torvaldse83c5162005-04-07 22:13:13869/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
Nicolas Pitre21666f12007-02-26 19:55:59870extern int sha1_object_info(const unsigned char *, unsigned long *);
Nicolas Pitrece9fbf12007-03-20 20:02:09871extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
Jeff Kingc00e6572010-04-02 00:03:18872extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
Nicolas Pitre21666f12007-02-26 19:55:59873extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
Nicolas Pitrebbac7312008-05-14 05:32:48874extern int force_object_loose(const unsigned char *sha1, time_t mtime);
Vicent Martiec73f582013-10-24 18:01:47875extern int git_open_noatime(const char *name);
Junio C Hamanof0270ef2011-05-15 02:42:10876extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
Junio C Hamanoeb4f4072011-07-19 16:33:03877extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
Junio C Hamanof0270ef2011-05-15 02:42:10878extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
Daniel Barkalow8237b182005-04-24 01:47:23879
Nicolas Pitre0e8189e2008-10-31 15:31:08880/* global flag to enable extra checks when accessing packed objects */
881extern int do_check_packed_object_crc;
882
Jason McMullan5d6ccf52005-06-03 15:05:39883extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
Linus Torvaldse83c5162005-04-07 22:13:13884
Junio C Hamano839837b2006-09-01 07:17:47885extern int move_temp_to_file(const char *tmpfile, const char *filename);
Daniel Barkalow8237b182005-04-24 01:47:23886
Junio C Hamanocd673c12009-02-28 07:15:53887extern int has_sha1_pack(const unsigned char *sha1);
Michael Haggertyd40d5352014-02-21 16:32:06888
889/*
890 * Return true iff we have an object named sha1, whether local or in
891 * an alternate object database, and whether packed or loose. This
892 * function does not respect replace references.
893 */
Daniel Barkalow8237b182005-04-24 01:47:23894extern int has_sha1_file(const unsigned char *sha1);
Michael Haggertyd40d5352014-02-21 16:32:06895
896/*
897 * Return true iff an alternate object database has a loose object
898 * with the specified name. This function does not respect replace
899 * references.
900 */
Brandon Casey0f4dc142008-11-10 05:59:57901extern int has_loose_object_nonlocal(const unsigned char *sha1);
Daniel Barkalow8237b182005-04-24 01:47:23902
barkalow@iabervon.orgbf592c52005-08-01 00:53:44903extern int has_pack_index(const unsigned char *sha1);
904
Jeff King40d52ff2010-04-02 00:05:23905extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
906
Linus Torvalds192a6be2007-05-30 17:32:19907extern const signed char hexval_table[256];
908static inline unsigned int hexval(unsigned char c)
Junio C Hamanoe49521b2006-09-20 23:04:46909{
910 return hexval_table[c];
911}
912
Linus Torvaldse83c5162005-04-07 22:13:13913/* Convert to/from hex/sha1 representation */
Linus Torvaldsdce96482010-10-28 18:28:04914#define MINIMUM_ABBREV minimum_abbrev
915#define DEFAULT_ABBREV default_abbrev
Junio C Hamano46a6c262006-01-25 09:03:18916
Clément Poulain573285e2010-06-09 17:02:06917struct object_context {
918 unsigned char tree[20];
919 char path[PATH_MAX];
920 unsigned mode;
921};
922
Junio C Hamanodaba53a2012-07-03 06:35:05923#define GET_SHA1_QUIETLY 01
924#define GET_SHA1_COMMIT 02
925#define GET_SHA1_COMMITTISH 04
926#define GET_SHA1_TREE 010
927#define GET_SHA1_TREEISH 020
928#define GET_SHA1_BLOB 040
Junio C Hamano33bd5982012-07-02 17:32:11929#define GET_SHA1_ONLY_TO_DIE 04000
Junio C Hamano37c00e52012-06-18 18:32:03930
Linus Torvalds3c249c92005-05-01 23:36:56931extern int get_sha1(const char *str, unsigned char *sha1);
Junio C Hamanodaba53a2012-07-03 06:35:05932extern int get_sha1_commit(const char *str, unsigned char *sha1);
Junio C Hamanocd74e472012-07-02 19:04:52933extern int get_sha1_committish(const char *str, unsigned char *sha1);
Junio C Hamanodaba53a2012-07-03 06:35:05934extern int get_sha1_tree(const char *str, unsigned char *sha1);
935extern int get_sha1_treeish(const char *str, unsigned char *sha1);
936extern int get_sha1_blob(const char *str, unsigned char *sha1);
Junio C Hamano8c135ea2012-07-02 18:01:25937extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
Junio C Hamano33bd5982012-07-02 17:32:11938extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
Michael Haggertyd4e85a12011-09-23 13:38:36939
Junio C Hamano957d7402012-07-03 21:21:59940typedef int each_abbrev_fn(const unsigned char *sha1, void *);
941extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
Michael Haggertyd4e85a12011-09-23 13:38:36942
943/*
944 * Try to read a SHA1 in hexadecimal format from the 40 characters
945 * starting at hex. Write the 20-byte result to sha1 in binary form.
946 * Return 0 on success. Reading stops if a NUL is encountered in the
947 * input, so it is safe to pass this function an arbitrary
948 * null-terminated string.
949 */
Linus Torvalds197ee8c2005-04-09 19:09:27950extern int get_sha1_hex(const char *hex, unsigned char *sha1);
Michael Haggertyd4e85a12011-09-23 13:38:36951
Linus Torvalds197ee8c2005-04-09 19:09:27952extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
Ronnie Sahlberg7695d112014-07-15 19:59:36953extern int read_ref_full(const char *refname, int resolve_flags,
954 unsigned char *sha1, int *flags);
Michael Haggertydfefa932011-12-12 05:38:09955extern int read_ref(const char *refname, unsigned char *sha1);
Michael Haggerty7cb36842011-09-15 21:10:42956
957/*
958 * Resolve a reference, recursively following symbolic refererences.
959 *
960 * Store the referred-to object's name in sha1 and return the name of
961 * the non-symbolic reference that ultimately pointed at it. The
962 * return value, if not NULL, is a pointer into either a static buffer
963 * or the input ref.
964 *
965 * If the reference cannot be resolved to an object, the behavior
Ronnie Sahlberg7695d112014-07-15 19:59:36966 * depends on the RESOLVE_REF_READING flag:
Michael Haggerty7cb36842011-09-15 21:10:42967 *
Ronnie Sahlberg7695d112014-07-15 19:59:36968 * - If RESOLVE_REF_READING is set, return NULL.
Michael Haggerty7cb36842011-09-15 21:10:42969 *
Ronnie Sahlberg7695d112014-07-15 19:59:36970 * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of
971 * the last reference name in the chain, which will either be a non-symbolic
Michael Haggerty7cb36842011-09-15 21:10:42972 * reference or an undefined reference. If this is a prelude to
973 * "writing" to the ref, the return value is the name of the ref
974 * that will actually be created or changed.
975 *
Jonathan Nieder62a2d522014-09-11 01:22:48976 * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one
977 * level of symbolic reference. The value stored in sha1 for a symbolic
978 * reference will always be null_sha1 in this case, and the return
979 * value is the reference that the symref refers to directly.
980 *
Ronnie Sahlberg7695d112014-07-15 19:59:36981 * If flags is non-NULL, set the value that it points to the
Michael Haggerty7cb36842011-09-15 21:10:42982 * combination of REF_ISPACKED (if the reference was found among the
Ronnie Sahlberg7695d112014-07-15 19:59:36983 * packed references), REF_ISSYMREF (if the initial reference was a
Ronnie Sahlbergd0f810f2014-09-03 18:45:43984 * symbolic reference), REF_BAD_NAME (if the reference name is ill
985 * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN
986 * (if the ref is malformed or has a bad name). See refs.h for more detail
987 * on each flag.
Michael Haggerty7cb36842011-09-15 21:10:42988 *
989 * If ref is not a properly-formatted, normalized reference, return
990 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
991 * give up and return NULL.
992 *
Ronnie Sahlbergd0f810f2014-09-03 18:45:43993 * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their
994 * name is invalid according to git-check-ref-format(1). If the name
995 * is bad then the value stored in sha1 will be null_sha1 and the two
996 * flags REF_ISBROKEN and REF_BAD_NAME will be set.
997 *
998 * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
999 * directory and do not consist of all caps and underscores cannot be
1000 * resolved. The function returns NULL for such ref names.
1001 * Caps and underscores refers to the special refs, such as HEAD,
1002 * FETCH_HEAD and friends, that all live outside of the refs/ directory.
Michael Haggerty7cb36842011-09-15 21:10:421003 */
Ronnie Sahlberg7695d112014-07-15 19:59:361004#define RESOLVE_REF_READING 0x01
Jonathan Nieder62a2d522014-09-11 01:22:481005#define RESOLVE_REF_NO_RECURSE 0x02
Ronnie Sahlbergd0f810f2014-09-03 18:45:431006#define RESOLVE_REF_ALLOW_BAD_NAME 0x04
Ronnie Sahlberg7695d112014-07-15 19:59:361007extern const char *resolve_ref_unsafe(const char *ref, int resolve_flags, unsigned char *sha1, int *flags);
1008extern char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags);
Michael Haggerty7cb36842011-09-15 21:10:421009
Junio C Hamanoe86eb662007-01-19 09:15:151010extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
Johannes Schindelineb3a4822007-02-09 00:28:231011extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
Felipe Contrerascf99a762013-09-02 06:34:291012extern int interpret_branch_name(const char *str, int len, struct strbuf *);
Junio C Hamano619a6442009-10-18 19:34:561013extern int get_sha1_mb(const char *str, unsigned char *sha1);
Junio C Hamanoe86eb662007-01-19 09:15:151014
Michael Haggerty54457fe2014-01-14 03:16:071015/*
1016 * Return true iff abbrev_name is a possible abbreviation for
1017 * full_name according to the rules defined by ref_rev_parse_rules in
1018 * refs.c.
1019 */
1020extern int refname_match(const char *abbrev_name, const char *full_name);
Steffen Prohaska79803322007-11-11 14:01:461021
Nicolas Pitre8b5157e2007-01-26 22:26:101022extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
Junio C Hamanoc847f532007-01-02 07:31:081023extern int validate_headref(const char *ref);
Linus Torvaldse83c5162005-04-07 22:13:131024
Linus Torvalds958ba6c2005-05-20 16:09:181025extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
Linus Torvalds0ab9e1e2008-03-06 02:25:101026extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
Jeremiah Mahlerccdd4a02014-06-20 02:06:441027extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
Thomas Gummererb60e1882012-07-11 09:22:371028extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
Linus Torvaldse83c5162005-04-07 22:13:131029
Junio C Hamano40469ee2005-04-28 23:42:271030extern void *read_object_with_reference(const unsigned char *sha1,
Brian Gerstbf0f9102005-05-18 12:14:091031 const char *required_type,
Junio C Hamano40469ee2005-04-28 23:42:271032 unsigned long *size,
1033 unsigned char *sha1_ret);
Junio C Hamanof4913f92005-04-21 01:06:491034
Junio C Hamano81776312007-12-24 08:51:011035extern struct object *peel_to_type(const char *name, int namelen,
1036 struct object *o, enum object_type);
1037
Junio C Hamano73013af2007-07-14 06:14:521038enum date_mode {
1039 DATE_NORMAL = 0,
1040 DATE_RELATIVE,
1041 DATE_SHORT,
1042 DATE_LOCAL,
1043 DATE_ISO8601,
Beat Bolli466fb672014-08-29 16:58:421044 DATE_ISO8601_STRICT,
Linus Torvalds7dff9b32009-02-20 22:15:221045 DATE_RFC2822,
1046 DATE_RAW
Junio C Hamano73013af2007-07-14 06:14:521047};
1048
Johannes Schindelinf8493ec2007-02-27 15:21:041049const char *show_date(unsigned long time, int timezone, enum date_mode mode);
Jonathan Nieder7d29afd2012-04-23 12:30:231050void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1051 struct strbuf *timebuf);
Jeff Kingc33ddc22014-08-27 07:57:081052int parse_date(const char *date, struct strbuf *out);
Jonathan Nieder9644c062010-07-15 16:22:571053int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
Junio C Hamano3d27b9b2013-04-17 22:38:081054int parse_expiry_date(const char *date, unsigned long *timestamp);
Jeff Kingc33ddc22014-08-27 07:57:081055void datestamp(struct strbuf *out);
Junio C Hamano93cfa7c2010-01-26 19:58:001056#define approxidate(s) approxidate_careful((s), NULL)
1057unsigned long approxidate_careful(const char *, int *);
Alex Riesen33012fc2009-08-31 02:26:051058unsigned long approxidate_relative(const char *date, const struct timeval *now);
Andy Parkins856665f2007-09-28 14:17:311059enum date_mode parse_date_format(const char *format);
Jeff King7ca36d92014-02-24 07:39:451060int date_overflows(unsigned long date);
Edgar Toernigecee9d92005-04-30 16:46:491061
Jeff Kingf9bc5732012-05-24 23:28:401062#define IDENT_STRICT 1
Jeff Kingb9f0ac12012-05-21 23:10:111063#define IDENT_NO_DATE 2
Jeff Kingc15e1982012-05-24 23:27:241064#define IDENT_NO_NAME 4
Junio C Hamano749be722006-02-19 04:31:051065extern const char *git_author_info(int);
1066extern const char *git_committer_info(int);
Junio C Hamano798123a2007-02-05 01:50:141067extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
Junio C Hamanod9ccfe72007-12-02 21:43:341068extern const char *fmt_name(const char *name, const char *email);
Matthieu Moy98305342014-07-25 19:11:341069extern const char *ident_default_name(void);
Jeff Kingbcb2b002012-05-21 23:09:431070extern const char *ident_default_email(void);
Jonathan Nieder44fcb492009-11-12 00:01:271071extern const char *git_editor(void);
Jonathan Nieder64778d22010-02-14 11:59:591072extern const char *git_pager(int stdout_is_tty);
Jeff King95979212012-05-21 23:09:541073extern int git_ident_config(const char *, const char *, void *);
Linus Torvalds6aa33f42005-07-12 18:49:271074
Junio C Hamano4b340cf2012-03-11 09:25:431075struct ident_split {
1076 const char *name_begin;
1077 const char *name_end;
1078 const char *mail_begin;
1079 const char *mail_end;
1080 const char *date_begin;
1081 const char *date_end;
1082 const char *tz_begin;
1083 const char *tz_end;
1084};
1085/*
1086 * Signals an success with 0, but time part of the result may be NULL
1087 * if the input lacks timestamp and zone
1088 */
1089extern int split_ident_line(struct ident_split *, const char *, int);
1090
Jeff King662cc302013-09-20 10:16:281091/*
Jeff Kingd1053242014-05-02 01:07:221092 * Like show_date, but pull the timestamp and tz parameters from
1093 * the ident_split. It will also sanity-check the values and produce
1094 * a well-known sentinel date if they appear bogus.
1095 */
1096const char *show_ident_date(const struct ident_split *id, enum date_mode mode);
1097
1098/*
Jeff King662cc302013-09-20 10:16:281099 * Compare split idents for equality or strict ordering. Note that we
1100 * compare only the ident part of the line, ignoring any timestamp.
1101 *
1102 * Because there are two fields, we must choose one as the primary key; we
1103 * currently arbitrarily pick the email.
1104 */
1105extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1106
Linus Torvalds12dccc12005-06-06 04:59:541107struct checkout {
Nguyễn Thái Ngọc Duyd4a20242014-06-13 12:19:341108 struct index_state *istate;
Linus Torvalds12dccc12005-06-06 04:59:541109 const char *base_dir;
1110 int base_dir_len;
1111 unsigned force:1,
1112 quiet:1,
1113 not_new:1,
1114 refresh_cache:1;
1115};
1116
Junio C Hamanoaf2a6512013-10-23 17:52:421117#define TEMPORARY_FILENAME_LENGTH 25
Luiz Fernando N. Capitulinoefbc5832007-04-25 14:18:081118extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
Linus Torvaldsb9fd2842009-07-09 20:35:311119
1120struct cache_def {
Karsten Bleese7c73052014-07-04 22:41:461121 struct strbuf path;
Linus Torvaldsb9fd2842009-07-09 20:35:311122 int flags;
1123 int track_flags;
1124 int prefix_len_stat_func;
1125};
Karsten Bleese7c73052014-07-04 22:41:461126#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
Karsten Blees2a608392014-07-11 23:02:341127static inline void cache_def_clear(struct cache_def *cache)
Karsten Bleese7c73052014-07-04 22:41:461128{
1129 strbuf_release(&cache->path);
1130}
Linus Torvaldsb9fd2842009-07-09 20:35:311131
Kjetil Barvik57199892009-02-09 20:54:061132extern int has_symlink_leading_path(const char *name, int len);
Linus Torvaldsb9fd2842009-07-09 20:35:311133extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
Clemens Buchacherf66caaf2010-10-09 13:53:001134extern int check_leading_path(const char *name, int len);
Kjetil Barvik57199892009-02-09 20:54:061135extern int has_dirs_only_path(const char *name, int len, int prefix_len);
Kjetil Barvik78478922009-02-09 20:54:071136extern void schedule_dir_for_removal(const char *name, int len);
1137extern void remove_scheduled_dirs(void);
Linus Torvalds12dccc12005-06-06 04:59:541138
Junio C Hamano9a217f22005-06-28 21:56:571139extern struct alternate_object_database {
Junio C Hamanod5a63b92005-08-15 00:25:571140 struct alternate_object_database *next;
Junio C Hamano9a217f22005-06-28 21:56:571141 char *name;
Junio C Hamano8f1d2e62006-01-07 09:33:541142 char base[FLEX_ARRAY]; /* more */
Junio C Hamanod5a63b92005-08-15 00:25:571143} *alt_odb_list;
Junio C Hamano9a217f22005-06-28 21:56:571144extern void prepare_alt_odb(void);
Heiko Voigt5e736332012-05-14 16:24:451145extern void read_info_alternates(const char * relative_base, int depth);
Daniel Barkalowbef70b22008-04-17 23:32:301146extern void add_to_alternates_file(const char *reference);
Junio C Hamanod79796b2008-09-09 08:27:101147typedef int alt_odb_fn(struct alternate_object_database *, void *);
Jeff Kingfe1b2262014-10-15 22:33:131148extern int foreach_alt_odb(alt_odb_fn, void*);
Junio C Hamano9a217f22005-06-28 21:56:571149
Shawn O. Pearcec41ee582006-12-23 07:33:441150struct pack_window {
1151 struct pack_window *next;
1152 unsigned char *base;
1153 off_t offset;
1154 size_t len;
1155 unsigned int last_used;
1156 unsigned int inuse_cnt;
1157};
1158
Junio C Hamano9a217f22005-06-28 21:56:571159extern struct packed_git {
1160 struct packed_git *next;
Shawn O. Pearcec41ee582006-12-23 07:33:441161 struct pack_window *windows;
Shawn O. Pearce2dc3a232006-12-23 07:33:471162 off_t pack_size;
Nicolas Pitre57059092007-04-09 05:06:281163 const void *index_data;
1164 size_t index_size;
1165 uint32_t num_objects;
Nicolas Pitre8eca0b42008-06-24 01:23:391166 uint32_t num_bad_objects;
1167 unsigned char *bad_object_sha1;
Nicolas Pitre42873072007-03-16 20:42:501168 int index_version;
Nicolas Pitre57059092007-04-09 05:06:281169 time_t mtime;
Shawn O. Pearce9bc879c2006-12-23 07:34:011170 int pack_fd;
Brandon Casey8d259312008-11-12 17:59:031171 unsigned pack_local:1,
Shawn O. Pearced131b7a2011-03-02 18:01:541172 pack_keep:1,
1173 do_not_close:1;
barkalow@iabervon.orgbf592c52005-08-01 00:53:441174 unsigned char sha1[20];
Junio C Hamano8f1d2e62006-01-07 09:33:541175 /* something like ".git/objects/pack/xxxxx.pack" */
1176 char pack_name[FLEX_ARRAY]; /* more */
Junio C Hamano9a217f22005-06-28 21:56:571177} *packed_git;
Junio C Hamanof3bf9222005-07-01 00:15:391178
1179struct pack_entry {
Shawn O. Pearcec4001d92007-03-07 01:44:301180 off_t offset;
Junio C Hamanof3bf9222005-07-01 00:15:391181 unsigned char sha1[20];
1182 struct packed_git *p;
1183};
1184
Shawn O. Pearce7b644692010-04-19 14:23:081185extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
barkalow@iabervon.orgbf592c52005-08-01 00:53:441186
Nguyễn Thái Ngọc Duy543c5ca2013-02-15 12:07:101187/* A hook for count-objects to report invalid files in pack directory */
1188extern void (*report_garbage)(const char *desc, const char *path);
1189
Junio C Hamano9a217f22005-06-28 21:56:571190extern void prepare_packed_git(void);
Shawn Pearcefc04c412006-11-01 22:06:211191extern void reprepare_packed_git(void);
barkalow@iabervon.orgbf592c52005-08-01 00:53:441192extern void install_packed_git(struct packed_git *pack);
1193
Junio C Hamanoa6080a02007-06-07 07:04:011194extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
barkalow@iabervon.orgbf592c52005-08-01 00:53:441195 struct packed_git *packs);
1196
Chris Wedgwood276bc2c2007-01-17 06:28:021197extern void pack_report(void);
Michael Haggertyd40d5352014-02-21 16:32:061198
1199/*
1200 * mmap the index file for the specified packfile (if it is not
1201 * already mmapped). Return 0 on success.
1202 */
Shawn O. Pearced0798372007-05-26 05:24:191203extern int open_pack_index(struct packed_git *);
Michael Haggertyd40d5352014-02-21 16:32:061204
1205/*
1206 * munmap the index file for the specified packfile (if it is
1207 * currently mmapped).
1208 */
Shawn O. Pearcefa5fc152010-04-19 14:23:061209extern void close_pack_index(struct packed_git *);
Michael Haggertyd40d5352014-02-21 16:32:061210
Junio C Hamanoef49a7a2011-06-10 18:52:151211extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
Shawn O. Pearcec9ced052008-01-18 03:57:001212extern void close_pack_windows(struct packed_git *);
Shawn O. Pearce03e79c82006-12-23 07:34:081213extern void unuse_pack(struct pack_window **);
Nicolas Pitrec74faea2008-12-09 19:26:521214extern void free_pack_by_name(const char *);
Shawn O. Pearce3d20c632009-02-10 21:36:121215extern void clear_delta_base_cache(void);
Nicolas Pitre42873072007-03-16 20:42:501216extern struct packed_git *add_packed_git(const char *, int, int);
Michael Haggertyd40d5352014-02-21 16:32:061217
1218/*
1219 * Return the SHA-1 of the nth object within the specified packfile.
1220 * Open the index if it is not already open. The return value points
1221 * at the SHA-1 within the mmapped index. Return NULL if there is an
1222 * error.
1223 */
1224extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1225
1226/*
1227 * Return the offset of the nth object within the specified packfile.
1228 * The index must already be opened.
1229 */
1230extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1231
1232/*
1233 * If the object named sha1 is present in the specified packfile,
1234 * return its offset within the packfile; otherwise, return 0.
1235 */
1236extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1237
Jeff King4c080182011-10-14 18:03:481238extern int is_pack_valid(struct packed_git *);
Shawn O. Pearcec4001d92007-03-07 01:44:301239extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
Nicolas Pitre09ded042008-10-29 23:02:461240extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
Nicolas Pitre54dab522007-04-16 16:31:561241extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
Junio C Hamanof8c8abc2011-05-13 22:33:331242extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
Junio C Hamano9a217f22005-06-28 21:56:571243
Jeff King27e1e222014-10-15 22:38:551244/*
1245 * Iterate over the files in the loose-object parts of the object
1246 * directory "path", triggering the following callbacks:
1247 *
1248 * - loose_object is called for each loose object we find.
1249 *
1250 * - loose_cruft is called for any files that do not appear to be
1251 * loose objects. Note that we only look in the loose object
1252 * directories "objects/[0-9a-f]{2}/", so we will not report
1253 * "objects/foobar" as cruft.
1254 *
1255 * - loose_subdir is called for each top-level hashed subdirectory
1256 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1257 * after the objects in the directory are processed.
1258 *
1259 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1260 * will end the iteration.
1261 */
1262typedef int each_loose_object_fn(const unsigned char *sha1,
1263 const char *path,
1264 void *data);
1265typedef int each_loose_cruft_fn(const char *basename,
1266 const char *path,
1267 void *data);
1268typedef int each_loose_subdir_fn(int nr,
1269 const char *path,
1270 void *data);
1271int for_each_loose_file_in_objdir(const char *path,
1272 each_loose_object_fn obj_cb,
1273 each_loose_cruft_fn cruft_cb,
1274 each_loose_subdir_fn subdir_cb,
1275 void *data);
1276
Jeff King660c8892014-10-15 22:41:211277/*
1278 * Iterate over loose and packed objects in both the local
1279 * repository and any alternates repositories.
1280 */
1281typedef int each_packed_object_fn(const unsigned char *sha1,
1282 struct packed_git *pack,
1283 uint32_t pos,
1284 void *data);
1285extern int for_each_loose_object(each_loose_object_fn, void *);
1286extern int for_each_packed_object(each_packed_object_fn, void *);
1287
Junio C Hamano9a490592011-05-12 22:51:381288struct object_info {
1289 /* Request */
Jeff King5b086402013-07-12 06:34:571290 enum object_type *typep;
Junio C Hamano9a490592011-05-12 22:51:381291 unsigned long *sizep;
Jeff King161f00e2013-07-07 10:04:001292 unsigned long *disk_sizep;
Jeff King5d642e72013-12-21 14:24:201293 unsigned char *delta_base_sha1;
Junio C Hamano9a490592011-05-12 22:51:381294
1295 /* Response */
1296 enum {
1297 OI_CACHED,
1298 OI_LOOSE,
Junio C Hamano5266d362011-05-13 20:20:431299 OI_PACKED,
1300 OI_DBCACHED
Junio C Hamano9a490592011-05-12 22:51:381301 } whence;
1302 union {
1303 /*
1304 * struct {
1305 * ... Nothing to expose in this case
1306 * } cached;
1307 * struct {
1308 * ... Nothing to expose in this case
1309 * } loose;
1310 */
1311 struct {
1312 struct packed_git *pack;
1313 off_t offset;
1314 unsigned int is_delta;
1315 } packed;
1316 } u;
1317};
Christian Couderde7b5d62013-12-11 07:46:071318extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
Junio C Hamano9a217f22005-06-28 21:56:571319
Junio C Hamano8f3f9b02005-07-24 00:54:411320/* Dumb servers support */
1321extern int update_server_info(int);
1322
Michael J Gruber7a397412011-05-17 15:38:521323/* git_config_parse_key() returns these negated: */
1324#define CONFIG_INVALID_KEY 1
1325#define CONFIG_NO_SECTION_OR_NAME 2
1326/* git_config_set(), git_config_set_multivar() return the above or these: */
1327#define CONFIG_NO_LOCK -1
1328#define CONFIG_INVALID_FILE 3
1329#define CONFIG_NO_WRITE 4
1330#define CONFIG_NOTHING_SET 5
1331#define CONFIG_INVALID_PATTERN 6
Junio C Hamano9409c7a2012-07-29 20:43:211332#define CONFIG_GENERIC_ERROR 7
Michael J Gruber7a397412011-05-17 15:38:521333
Jeff Kingc1063be2014-08-19 06:20:001334#define CONFIG_REGEX_NONE ((void *)1)
1335
Kirill A. Shutemovc8985ce2014-02-18 22:58:541336struct git_config_source {
Kirill A. Shutemov3caec732014-02-18 22:58:551337 unsigned int use_stdin:1;
Kirill A. Shutemovc8985ce2014-02-18 22:58:541338 const char *file;
1339 const char *blob;
1340};
1341
Johannes Schindelinef90d6d2008-05-14 17:46:531342typedef int (*config_fn_t)(const char *, const char *, void *);
1343extern int git_default_config(const char *, const char *, void *);
1344extern int git_config_from_file(config_fn_t fn, const char *, void *);
Heiko Voigt1bc88812013-07-11 22:46:471345extern int git_config_from_buf(config_fn_t fn, const char *name,
1346 const char *buf, size_t len, void *data);
Jeff King2b64fc82010-08-23 19:16:001347extern void git_config_push_parameter(const char *text);
Thomas Rastb3d83d92010-05-21 10:07:471348extern int git_config_from_parameters(config_fn_t fn, void *data);
Tanay Abhraaace4382014-08-07 11:59:151349extern void git_config(config_fn_t fn, void *);
Jeff King9b25a0b2012-02-06 09:54:041350extern int git_config_with_options(config_fn_t fn, void *,
Kirill A. Shutemovc8985ce2014-02-18 22:58:541351 struct git_config_source *config_source,
Heiko Voigt1bc88812013-07-11 22:46:471352 int respect_includes);
Nguyễn Thái Ngọc Duydbdf5852010-11-26 15:32:331353extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
Brian Downing0b87b6e2007-07-12 13:32:261354extern int git_parse_ulong(const char *, unsigned long *);
Linus Torvalds17712992005-10-10 23:31:081355extern int git_config_int(const char *, const char *);
Jeff King00160242013-09-08 08:40:021356extern int64_t git_config_int64(const char *, const char *);
Brian Downing0b87b6e2007-07-12 13:32:261357extern unsigned long git_config_ulong(const char *, const char *);
Junio C Hamanoa53f2ec2008-04-13 01:33:311358extern int git_config_bool_or_int(const char *, const char *, int *);
Linus Torvalds17712992005-10-10 23:31:081359extern int git_config_bool(const char *, const char *);
Junio C Hamano8420ccd2010-02-17 07:59:461360extern int git_config_maybe_bool(const char *, const char *);
Christian Couderea5105a2008-02-16 05:00:241361extern int git_config_string(const char **, const char *, const char *);
Matthieu Moy395de252009-11-17 17:24:251362extern int git_config_pathname(const char **, const char *, const char *);
Ramkumar Ramachandra5ec31182011-08-04 10:39:001363extern int git_config_set_in_file(const char *, const char *, const char *);
Johannes Schindelin10bea152005-11-17 21:32:361364extern int git_config_set(const char *, const char *);
Libor Pechacekb09c53a2011-01-30 19:40:411365extern int git_config_parse_key(const char *, char **, int *);
Johannes Schindelin4ddba792005-11-20 05:52:221366extern int git_config_set_multivar(const char *, const char *, const char *, int);
Ramkumar Ramachandra5ec31182011-08-04 10:39:001367extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
Johannes Schindelin0667fcf2006-12-16 14:14:141368extern int git_config_rename_section(const char *, const char *);
Jeff King42bd39b2012-02-16 08:04:251369extern int git_config_rename_section_in_file(const char *, const char *, const char *);
Johannes Sixt506b17b2007-11-13 20:05:051370extern const char *git_etc_gitconfig(void);
Johannes Schindelinef90d6d2008-05-14 17:46:531371extern int check_repository_format_version(const char *var, const char *value, void *cb);
Lars R. Damerow0ef37162010-03-17 19:55:511372extern int git_env_bool(const char *, int);
Steffen Prohaska23b0c472014-08-26 15:23:211373extern unsigned long git_env_ulong(const char *, unsigned long);
Jeff Kingab88c362008-02-06 10:11:181374extern int git_config_system(void);
Junio C Hamano40ea4ed2008-02-11 18:41:181375extern int config_error_nonbool(const char *);
Jeff Kingff0a80a2014-05-06 15:17:501376#if defined(__GNUC__)
Jeff King87fe5df2014-05-06 15:14:421377#define config_error_nonbool(s) (config_error_nonbool(s), const_error())
Jeff Kinga469a102012-12-15 17:42:101378#endif
Pat Notza6fa5992010-11-02 19:59:071379extern const char *get_log_output_encoding(void);
1380extern const char *get_commit_output_encoding(void);
1381
Jeff King24968442011-06-09 15:56:421382extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1383
Jeff King9b25a0b2012-02-06 09:54:041384struct config_include_data {
1385 int depth;
1386 config_fn_t fn;
1387 void *data;
1388};
1389#define CONFIG_INCLUDE_INIT { 0 }
1390extern int git_config_include(const char *name, const char *value, void *data);
Linus Torvalds17712992005-10-10 23:31:081391
Jeff King1b86bbb2013-01-23 06:23:051392/*
1393 * Match and parse a config key of the form:
1394 *
1395 * section.(subsection.)?key
1396 *
1397 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1398 * we return -1 if it does not match, 0 otherwise. The subsection and key
1399 * out-parameters are filled by the function (and subsection is NULL if it is
1400 * missing).
1401 */
1402extern int parse_config_key(const char *var,
1403 const char *section,
1404 const char **subsection, int *subsection_len,
1405 const char **key);
1406
Tanay Abhra155ef252014-08-07 11:59:171407struct config_set_element {
1408 struct hashmap_entry ent;
1409 char *key;
1410 struct string_list value_list;
1411};
1412
1413struct configset_list_item {
1414 struct config_set_element *e;
1415 int value_index;
1416};
1417
1418/*
1419 * the contents of the list are ordered according to their
1420 * position in the config files and order of parsing the files.
1421 * (i.e. key-value pair at the last position of .git/config will
1422 * be at the last item of the list)
1423 */
1424struct configset_list {
1425 struct configset_list_item *items;
1426 unsigned int nr, alloc;
1427};
1428
Tanay Abhra3c8687a2014-07-28 10:10:381429struct config_set {
1430 struct hashmap config_hash;
1431 int hash_initialized;
Tanay Abhra155ef252014-08-07 11:59:171432 struct configset_list list;
Tanay Abhra3c8687a2014-07-28 10:10:381433};
1434
1435extern void git_configset_init(struct config_set *cs);
1436extern int git_configset_add_file(struct config_set *cs, const char *filename);
1437extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
1438extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
1439extern void git_configset_clear(struct config_set *cs);
1440extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
1441extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
1442extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
1443extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
1444extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
1445extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
1446extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
1447extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
1448
1449extern int git_config_get_value(const char *key, const char **value);
1450extern const struct string_list *git_config_get_value_multi(const char *key);
1451extern void git_config_clear(void);
1452extern void git_config_iter(config_fn_t fn, void *data);
1453extern int git_config_get_string_const(const char *key, const char **dest);
1454extern int git_config_get_string(const char *key, char **dest);
1455extern int git_config_get_int(const char *key, int *dest);
1456extern int git_config_get_ulong(const char *key, unsigned long *dest);
1457extern int git_config_get_bool(const char *key, int *dest);
1458extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
1459extern int git_config_get_maybe_bool(const char *key, int *dest);
1460extern int git_config_get_pathname(const char *key, const char **dest);
1461
Tanay Abhra3df8fd62014-08-07 11:59:141462struct key_value_info {
1463 const char *filename;
1464 int linenr;
1465};
1466
Tanay Abhra5a80e972014-08-07 11:59:161467extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
1468extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
1469
Jeff Kingd6991ce2012-11-15 00:34:131470extern int committer_ident_sufficiently_given(void);
1471extern int author_ident_sufficiently_given(void);
Linus Torvaldse1b10392005-10-12 01:47:341472
Shawn O. Pearce1a8f2742007-03-12 19:33:181473extern const char *git_commit_encoding;
Shawn O. Pearce3a556022007-03-07 01:44:171474extern const char *git_log_output_encoding;
Marius Storm-Olsend551a482009-02-08 14:34:271475extern const char *git_mailmap_file;
Jeff King08610902012-12-12 11:04:041476extern const char *git_mailmap_blob;
Junio C Hamano4e72dce2005-11-28 00:09:401477
Theodore Ts'o06f59e92007-06-29 17:40:461478/* IO helper functions */
1479extern void maybe_flush_or_die(FILE *, const char *);
Jeff King9540ce52014-09-10 10:03:521480__attribute__((format (printf, 2, 3)))
1481extern void fprintf_or_die(FILE *, const char *fmt, ...);
Junio C Hamanof3123c42005-10-22 08:28:131482extern int copy_fd(int ifd, int ofd);
Daniel Barkalow1468bd42008-02-25 19:24:481483extern int copy_file(const char *dst, const char *src, int mode);
Clemens Buchacherf7835a22009-09-12 09:03:481484extern int copy_file_with_time(const char *dst, const char *src, int mode);
Rene Scharfe7230e6d2006-08-21 18:43:431485extern void write_or_die(int fd, const void *buf, size_t count);
Christian Couder6ce4e612006-09-02 16:23:481486extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
Andy Whitcrofte0814052007-01-08 15:57:521487extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
Linus Torvalds4c81b032008-05-30 15:42:161488extern void fsync_or_die(int fd, const char *);
Junio C Hamanoad897212005-12-15 06:17:381489
Jim Meyering2b7ca832009-09-12 08:54:321490extern ssize_t read_in_full(int fd, void *buf, size_t count);
1491extern ssize_t write_in_full(int fd, const void *buf, size_t count);
Yiannis Marangos426ddee2014-04-10 18:31:211492extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1493
Jim Meyering2b7ca832009-09-12 08:54:321494static inline ssize_t write_str_in_full(int fd, const char *str)
1495{
1496 return write_in_full(fd, str, strlen(str));
1497}
1498
Linus Torvaldsf67b45f2006-02-28 19:26:211499/* pager.c */
1500extern void setup_pager(void);
Christian Couder872da322008-02-16 05:01:111501extern const char *pager_program;
Jeff King6e9af862007-12-11 06:27:331502extern int pager_in_use(void);
Matthias Lederhoferaa086eb2006-07-29 22:27:431503extern int pager_use_color;
Zbigniew Jędrzejewski-Szmekad6c3732012-02-12 14:12:321504extern int term_columns(void);
Zbigniew Jędrzejewski-Szmekec7ff5b2012-02-12 14:16:201505extern int decimal_width(int);
Nguyễn Thái Ngọc Duy4914c962012-10-26 15:53:521506extern int check_pager_config(const char *cmd);
Linus Torvaldsf67b45f2006-02-28 19:26:211507
Christian Couderee9601e2008-02-16 05:01:411508extern const char *editor_program;
Anselm Kruisd3e7da82010-08-30 13:38:381509extern const char *askpass_program;
Christian Couderdfb068b2008-02-16 05:01:591510extern const char *excludes_file;
Johannes Schindelin4d87b9c2007-07-20 12:06:091511
Junio C Hamano051308f2006-05-04 23:51:441512/* base85 */
Jim Meyeringf9815772007-04-09 22:56:331513int decode_85(char *dst, const char *line, int linelen);
1514void encode_85(char *buf, const unsigned char *data, int bytes);
Junio C Hamano051308f2006-05-04 23:51:441515
Linus Torvalds855419f2006-06-19 17:44:151516/* alloc.c */
Linus Torvalds100c5f32007-04-17 05:11:431517extern void *alloc_blob_node(void);
1518extern void *alloc_tree_node(void);
1519extern void *alloc_commit_node(void);
1520extern void *alloc_tag_node(void);
1521extern void *alloc_object_node(void);
Linus Torvalds855419f2006-06-19 17:44:151522extern void alloc_report(void);
Jeff King94d5a222014-07-13 06:42:081523extern unsigned int alloc_commit_index(void);
Linus Torvalds855419f2006-06-19 17:44:151524
Karsten Blees5991a552014-06-11 07:56:491525/* pkt-line.c */
Jeff Kingbbc30f92011-02-24 14:30:191526void packet_trace_identity(const char *prog);
Christian Couder6ce4e612006-09-02 16:23:481527
Junio C Hamanob6ec1d62007-11-18 09:12:041528/* add */
Alex Riesen7ae02a32008-05-12 17:58:101529/*
1530 * return 0 if success, 1 - if addition of a file failed and
1531 * ADD_FILES_IGNORE_ERRORS was specified in flags
1532 */
Nguyễn Thái Ngọc Duy3efe8e42013-07-14 08:35:561533int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
Junio C Hamanob6ec1d62007-11-18 09:12:041534
Junio C Hamanoaecbf912007-08-31 20:13:421535/* diff.c */
1536extern int diff_auto_refresh_index;
1537
Junio C Hamano68faf682007-02-16 00:32:451538/* match-trees.c */
1539void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
Junio C Hamano85e51b72008-07-01 05:18:571540void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
Junio C Hamano68faf682007-02-16 00:32:451541
Junio C Hamanoa9cc8572007-11-02 07:24:271542/*
1543 * whitespace rules.
1544 * used by both diff and apply
Johannes Sixtf4b05a42010-11-30 08:29:111545 * last two digits are tab width
Junio C Hamanoa9cc8572007-11-02 07:24:271546 */
Johannes Sixtf4b05a42010-11-30 08:29:111547#define WS_BLANK_AT_EOL 0100
1548#define WS_SPACE_BEFORE_TAB 0200
1549#define WS_INDENT_WITH_NON_TAB 0400
1550#define WS_CR_AT_EOL 01000
1551#define WS_BLANK_AT_EOF 02000
1552#define WS_TAB_IN_INDENT 04000
Junio C Hamanoaeb84b02009-09-06 05:21:171553#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
Johannes Sixtf4b05a42010-11-30 08:29:111554#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1555#define WS_TAB_WIDTH_MASK 077
Junio C Hamanocf1b7862007-12-06 08:14:141556extern unsigned whitespace_rule_cfg;
1557extern unsigned whitespace_rule(const char *);
1558extern unsigned parse_whitespace_rule(const char *);
Junio C Hamano8f8841e2008-06-26 22:35:211559extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1560extern 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 13:32:291561extern char *whitespace_error_string(unsigned ws);
Chris Webbd511bd32010-04-02 23:37:231562extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
Junio C Hamano877f23c2008-06-26 22:36:591563extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
Johannes Sixtf4b05a42010-11-30 08:29:111564#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
Junio C Hamanoa9cc8572007-11-02 07:24:271565
Junio C Hamanoee425e42007-11-18 09:13:321566/* ls-files */
Nguyễn Thái Ngọc Duy17ddc662013-07-14 08:35:531567int report_path_error(const char *ps_matched, const struct pathspec *pathspec, const char *prefix);
Junio C Hamanoee425e42007-11-18 09:13:321568void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1569
Jeff King94351112008-02-24 22:17:141570char *alias_lookup(const char *alias);
Miklos Vajna0989fe92008-06-27 16:21:541571int split_cmdline(char *cmdline, const char ***argv);
Greg Brockmanad9ac6d2010-08-07 05:13:391572/* Takes a negative value returned by split_cmdline */
1573const char *split_cmdline_strerror(int cmdline_errno);
Jeff King94351112008-02-24 22:17:141574
Nguyễn Thái Ngọc Duye37c1322010-08-06 02:40:351575/* git.c */
1576struct startup_info {
Nguyễn Thái Ngọc Duya60645f2010-08-06 02:46:331577 int have_repository;
Nguyễn Thái Ngọc Duyf07d6a12010-12-01 23:33:221578 const char *prefix;
Nguyễn Thái Ngọc Duye37c1322010-08-06 02:40:351579};
1580extern struct startup_info *startup_info;
1581
Nguyễn Thái Ngọc Duydb699a82012-10-26 15:53:491582/* merge.c */
1583struct commit_list;
1584int try_merge_command(const char *strategy, size_t xopts_nr,
1585 const char **xopts, struct commit_list *common,
1586 const char *head_arg, struct commit_list *remotes);
1587int checkout_fast_forward(const unsigned char *from,
1588 const unsigned char *to,
1589 int overwrite_ignore);
1590
Junio C Hamanocac42b22010-03-06 20:34:411591
Jeff King38f865c2012-03-30 07:52:181592int sane_execvp(const char *file, char *const argv[]);
1593
Michael Haggerty38612532013-06-20 08:37:511594/*
1595 * A struct to encapsulate the concept of whether a file has changed
1596 * since we last checked it. This uses criteria similar to those used
1597 * for the index.
1598 */
1599struct stat_validity {
1600 struct stat_data *sd;
1601};
1602
1603void stat_validity_clear(struct stat_validity *sv);
1604
1605/*
1606 * Returns 1 if the path is a regular file (or a symlink to a regular
1607 * file) and matches the saved stat_validity, 0 otherwise. A missing
1608 * or inaccessible file is considered a match if the struct was just
1609 * initialized, or if the previous update found an inaccessible file.
1610 */
1611int stat_validity_check(struct stat_validity *sv, const char *path);
1612
1613/*
1614 * Update the stat_validity from a file opened at descriptor fd. If
1615 * the file is missing, inaccessible, or not a regular file, then
1616 * future calls to stat_validity_check will match iff one of those
1617 * conditions continues to be true.
1618 */
1619void stat_validity_update(struct stat_validity *sv, int fd);
1620
Nguyễn Thái Ngọc Duy9ef176b2014-02-27 12:56:521621int versioncmp(const char *s1, const char *s2);
1622
Linus Torvaldse83c5162005-04-07 22:13:131623#endif /* CACHE_H */