🌐 AI搜索 & 代理 主页
blob: 4cba08ecb1096dfdbcaae0eb82adad4a7825d35d [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"
Jeff Kingf4015332015-12-21 06:19:4912#include "pack-revindex.h"
Linus Torvaldse83c5162005-04-07 22:13:1313
Linus Torvaldscef661f2005-04-21 19:33:2214#include SHA1_HEADER
Atousa Pahlevan Duprat3bc72fd2015-11-05 06:38:4115#ifndef platform_SHA_CTX
16/*
17 * platform's underlying implementation of SHA-1; could be OpenSSL,
18 * blk_SHA, Apple CommonCrypto, etc... Note that including
19 * SHA1_HEADER may have already defined platform_SHA_CTX for our
20 * own implementations like block-sha1 and ppc-sha1, so we list
21 * the default for OpenSSL compatible SHA-1 implementations here.
22 */
23#define platform_SHA_CTX SHA_CTX
24#define platform_SHA1_Init SHA1_Init
25#define platform_SHA1_Update SHA1_Update
26#define platform_SHA1_Final SHA1_Final
Nicolas Pitre9126f002008-10-01 18:05:2027#endif
Linus Torvaldse83c5162005-04-07 22:13:1328
Atousa Pahlevan Duprat3bc72fd2015-11-05 06:38:4129#define git_SHA_CTX platform_SHA_CTX
30#define git_SHA1_Init platform_SHA1_Init
31#define git_SHA1_Update platform_SHA1_Update
32#define git_SHA1_Final platform_SHA1_Final
33
Atousa Pahlevan Duprat001fd7a2015-11-05 06:38:4234#ifdef SHA1_MAX_BLOCK_SIZE
35#include "compat/sha1-chunked.h"
36#undef git_SHA1_Update
37#define git_SHA1_Update git_SHA1_Update_Chunked
Nicolas Pitre9126f002008-10-01 18:05:2038#endif
Linus Torvaldse83c5162005-04-07 22:13:1339
Nicolas Pitre9126f002008-10-01 18:05:2040#include <zlib.h>
Junio C Hamanoef49a7a2011-06-10 18:52:1541typedef struct git_zstream {
42 z_stream z;
43 unsigned long avail_in;
44 unsigned long avail_out;
45 unsigned long total_in;
46 unsigned long total_out;
47 unsigned char *next_in;
48 unsigned char *next_out;
49} git_zstream;
Edgar Toernig9da3acf2005-04-30 16:51:0350
Junio C Hamanoef49a7a2011-06-10 18:52:1551void git_inflate_init(git_zstream *);
52void git_inflate_init_gzip_only(git_zstream *);
53void git_inflate_end(git_zstream *);
54int git_inflate(git_zstream *, int flush);
Linus Torvalds39c68542009-01-08 03:54:4755
Junio C Hamanoef49a7a2011-06-10 18:52:1556void git_deflate_init(git_zstream *, int level);
57void git_deflate_init_gzip(git_zstream *, int level);
René Scharfec3c2e1a2013-03-15 22:21:5158void git_deflate_init_raw(git_zstream *, int level);
Junio C Hamanoef49a7a2011-06-10 18:52:1559void git_deflate_end(git_zstream *);
Junio C Hamano568508e2011-10-28 21:48:4060int git_deflate_abort(git_zstream *);
Junio C Hamanoef49a7a2011-06-10 18:52:1561int git_deflate_end_gently(git_zstream *);
62int git_deflate(git_zstream *, int flush);
63unsigned long git_deflate_bound(git_zstream *, unsigned long);
Linus Torvalds39c68542009-01-08 03:54:4764
brian m. carlson5f7817c2015-03-13 23:39:2765/* The length in bytes and in hex digits of an object name (SHA-1 value). */
66#define GIT_SHA1_RAWSZ 20
67#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
68
69struct object_id {
70 unsigned char hash[GIT_SHA1_RAWSZ];
71};
72
Timo Hirvonen962554c2006-02-26 15:13:4673#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
Edgar Toernigb6829692005-04-30 16:51:0374#define DTYPE(de) ((de)->d_type)
75#else
Junio C Hamano0bdd79a2006-01-20 21:33:2076#undef DT_UNKNOWN
77#undef DT_DIR
78#undef DT_REG
79#undef DT_LNK
Edgar Toernigb6829692005-04-30 16:51:0380#define DT_UNKNOWN 0
81#define DT_DIR 1
82#define DT_REG 2
Junio C Hamanoa15c1c62005-05-13 00:16:0483#define DT_LNK 3
Edgar Toernigb6829692005-04-30 16:51:0384#define DTYPE(de) DT_UNKNOWN
85#endif
86
Martin Koegler40689ae2007-04-22 16:43:5687/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
88#define S_IFINVALID 0030000
89
Linus Torvaldse83c5162005-04-07 22:13:1390/*
Linus Torvalds9eec4792007-04-10 04:14:5891 * A "directory link" is a link to another git directory.
92 *
93 * The value 0160000 is not normally a valid mode, and
94 * also just happens to be S_IFDIR + S_IFLNK
Linus Torvalds9eec4792007-04-10 04:14:5895 */
Martin Waitz302b9282007-05-21 20:08:2896#define S_IFGITLINK 0160000
97#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
Linus Torvalds9eec4792007-04-10 04:14:5898
99/*
Kirill Smelkov72441af2014-04-06 21:46:26100 * Some mode bits are also used internally for computations.
101 *
102 * They *must* not overlap with any valid modes, and they *must* not be emitted
103 * to outside world - i.e. appear on disk or network. In other words, it's just
104 * temporary fields, which we internally use, but they have to stay in-house.
105 *
106 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
107 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
108 */
109
110/* used internally in tree-diff */
111#define S_DIFFTREE_IFXMIN_NEQ 0x80000000
112
113
114/*
Linus Torvalds2386d652005-07-14 01:46:20115 * Intensive research over the course of many years has shown that
116 * port 9418 is totally unused by anything else. Or
117 *
118 * Your search - "port 9418" - did not match any documents.
119 *
120 * as www.google.com puts it.
Linus Torvaldsba8a4972005-09-12 18:23:00121 *
122 * This port has been properly assigned for git use by IANA:
123 * git (Assigned-9418) [I06-050728-0001].
124 *
125 * git 9418/tcp git pack transfer service
126 * git 9418/udp git pack transfer service
127 *
128 * with Linus Torvalds <torvalds@osdl.org> as the point of
129 * contact. September 2005.
130 *
131 * See http://www.iana.org/assignments/port-numbers
Linus Torvalds2386d652005-07-14 01:46:20132 */
133#define DEFAULT_GIT_PORT 9418
134
135/*
Linus Torvaldse83c5162005-04-07 22:13:13136 * Basic data structures for the directory cache
Linus Torvaldse83c5162005-04-07 22:13:13137 */
138
139#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
140struct cache_header {
Thomas Gummerer7800c1e2013-08-18 19:41:51141 uint32_t hdr_signature;
142 uint32_t hdr_version;
143 uint32_t hdr_entries;
Linus Torvaldse83c5162005-04-07 22:13:13144};
145
Junio C Hamano9d227782012-04-04 16:12:43146#define INDEX_FORMAT_LB 2
147#define INDEX_FORMAT_UB 4
148
Linus Torvaldse83c5162005-04-07 22:13:13149/*
150 * The "cache_time" is just the low 32 bits of the
151 * time. It doesn't matter if it overflows - we only
152 * check it for equality in the 32 bits we save.
153 */
154struct cache_time {
Thomas Gummerer7800c1e2013-08-18 19:41:51155 uint32_t sec;
156 uint32_t nsec;
Linus Torvaldse83c5162005-04-07 22:13:13157};
158
Michael Haggertyc21d39d2013-06-20 08:37:50159struct stat_data {
160 struct cache_time sd_ctime;
161 struct cache_time sd_mtime;
162 unsigned int sd_dev;
163 unsigned int sd_ino;
164 unsigned int sd_uid;
165 unsigned int sd_gid;
166 unsigned int sd_size;
167};
168
Linus Torvaldse83c5162005-04-07 22:13:13169struct cache_entry {
Karsten Blees8b013782013-11-14 19:21:58170 struct hashmap_entry ent;
Michael Haggertyc21d39d2013-06-20 08:37:50171 struct stat_data ce_stat_data;
Linus Torvaldsccc4feb2005-04-15 17:44:27172 unsigned int ce_mode;
Linus Torvalds7a51ed62008-01-15 00:03:17173 unsigned int ce_flags;
Thomas Gummererb60e1882012-07-11 09:22:37174 unsigned int ce_namelen;
Nguyễn Thái Ngọc Duy5fc2fc82014-06-13 12:19:36175 unsigned int index; /* for link extension */
Linus Torvaldse83c5162005-04-07 22:13:13176 unsigned char sha1[20];
Junio C Hamano8f1d2e62006-01-07 09:33:54177 char name[FLEX_ARRAY]; /* more */
Linus Torvaldse83c5162005-04-07 22:13:13178};
179
Linus Torvalds95fd5bf2005-04-16 05:51:44180#define CE_STAGEMASK (0x3000)
Junio C Hamano16ce2e4c2008-08-17 06:02:08181#define CE_EXTENDED (0x4000)
Junio C Hamano5f730762006-02-09 05:15:24182#define CE_VALID (0x8000)
Junio C Hamanoaee46192005-04-16 15:33:23183#define CE_STAGESHIFT 12
Linus Torvalds95fd5bf2005-04-16 05:51:44184
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01185/*
Nguyễn Thái Ngọc Duyce51bf02014-06-13 12:19:25186 * Range 0xFFFF0FFF in ce_flags is divided into
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01187 * two parts: in-memory flags and on-disk ones.
188 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
189 * if you want to save a new flag, add it in
190 * CE_EXTENDED_FLAGS
191 *
192 * In-memory only flags
193 */
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16194#define CE_UPDATE (1 << 16)
195#define CE_REMOVE (1 << 17)
196#define CE_UPTODATE (1 << 18)
197#define CE_ADDED (1 << 19)
Linus Torvaldsa22c6372008-02-23 04:37:40198
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16199#define CE_HASHED (1 << 20)
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16200#define CE_WT_REMOVE (1 << 22) /* remove in work directory */
201#define CE_CONFLICTED (1 << 23)
Linus Torvalds7a51ed62008-01-15 00:03:17202
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16203#define CE_UNPACKED (1 << 24)
Nguyễn Thái Ngọc Duy2431afb2010-11-27 06:24:04204#define CE_NEW_SKIP_WORKTREE (1 << 25)
Junio C Hamanoda165f42010-01-07 22:59:54205
Nguyễn Thái Ngọc Duye721c152013-03-27 05:58:21206/* used to temporarily mark paths matched by pathspecs */
207#define CE_MATCHED (1 << 26)
208
Nguyễn Thái Ngọc Duy078a58e2014-06-13 12:19:39209#define CE_UPDATE_IN_BASE (1 << 27)
Nguyễn Thái Ngọc Duyb3c96fb2014-06-13 12:19:43210#define CE_STRIP_NAME (1 << 28)
Nguyễn Thái Ngọc Duy078a58e2014-06-13 12:19:39211
Linus Torvaldsd070e3a2008-02-23 04:39:21212/*
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01213 * Extended on-disk flags
214 */
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16215#define CE_INTENT_TO_ADD (1 << 29)
216#define CE_SKIP_WORKTREE (1 << 30)
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01217/* CE_EXTENDED2 is for future extension */
Jeff King9a93c662015-12-29 06:35:46218#define CE_EXTENDED2 (1U << 31)
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01219
Nguyễn Thái Ngọc Duy44a36912009-08-20 13:46:57220#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01221
222/*
223 * Safeguard to avoid saving wrong flags:
224 * - CE_EXTENDED2 won't get saved until its semantic is known
225 * - Bits in 0x0000FFFF have been saved in ce_flags already
226 * - Bits in 0x003F0000 are currently in-memory flags
227 */
228#if CE_EXTENDED_FLAGS & 0x803FFFFF
229#error "CE_EXTENDED_FLAGS out of range"
230#endif
231
Junio C Hamano3e3a4a42016-02-16 22:34:44232/* Forward structure decls */
Nguyễn Thái Ngọc Duy64acde92013-07-14 08:35:25233struct pathspec;
Junio C Hamano3e3a4a42016-02-16 22:34:44234struct child_process;
Nguyễn Thái Ngọc Duy64acde92013-07-14 08:35:25235
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01236/*
Linus Torvaldseb7a2f12008-02-23 04:41:17237 * Copy the sha1 and stat state of a cache entry from one to
238 * another. But we never change the name, or the hash state!
239 */
René Scharfe20d142b2013-06-02 15:46:51240static inline void copy_cache_entry(struct cache_entry *dst,
241 const struct cache_entry *src)
Linus Torvaldseb7a2f12008-02-23 04:41:17242{
Karsten Blees419a5972013-11-14 19:22:27243 unsigned int state = dst->ce_flags & CE_HASHED;
Linus Torvaldseb7a2f12008-02-23 04:41:17244
245 /* Don't copy hash chain and name */
Karsten Blees8b013782013-11-14 19:21:58246 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
247 offsetof(struct cache_entry, name) -
248 offsetof(struct cache_entry, ce_stat_data));
Linus Torvaldseb7a2f12008-02-23 04:41:17249
250 /* Restore the hash state */
Karsten Blees419a5972013-11-14 19:22:27251 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
Linus Torvaldseb7a2f12008-02-23 04:41:17252}
253
Thomas Gummererb60e1882012-07-11 09:22:37254static inline unsigned create_ce_flags(unsigned stage)
Junio C Hamano7fec10b2008-01-19 07:42:00255{
Thomas Gummererb60e1882012-07-11 09:22:37256 return (stage << CE_STAGESHIFT);
Junio C Hamano7fec10b2008-01-19 07:42:00257}
258
Thomas Gummererb60e1882012-07-11 09:22:37259#define ce_namelen(ce) ((ce)->ce_namelen)
Junio C Hamanoaee46192005-04-16 15:33:23260#define ce_size(ce) cache_entry_size(ce_namelen(ce))
Linus Torvalds7a51ed62008-01-15 00:03:17261#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
Junio C Hamanoeadb5832008-01-19 07:45:24262#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
Nguyễn Thái Ngọc Duy44a36912009-08-20 13:46:57263#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
Junio C Hamanoeadb5832008-01-19 07:45:24264#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
Nguyễn Thái Ngọc Duy895ff3b2015-08-22 01:08:05265#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
Junio C Hamanoaee46192005-04-16 15:33:23266
Linus Torvaldse4479472005-04-17 05:26:31267#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
Kay Sievers8ae0a8c2005-05-05 12:38:25268static inline unsigned int create_ce_mode(unsigned int mode)
269{
Kay Sievers8ae0a8c2005-05-05 12:38:25270 if (S_ISLNK(mode))
Linus Torvalds7a51ed62008-01-15 00:03:17271 return S_IFLNK;
Martin Waitz302b9282007-05-21 20:08:28272 if (S_ISDIR(mode) || S_ISGITLINK(mode))
Linus Torvalds7a51ed62008-01-15 00:03:17273 return S_IFGITLINK;
274 return S_IFREG | ce_permissions(mode);
Kay Sievers8ae0a8c2005-05-05 12:38:25275}
René Scharfe20d142b2013-06-02 15:46:51276static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
277 unsigned int mode)
Junio C Hamano185c9752007-02-17 06:43:48278{
Johannes Sixt78a8d642007-03-02 21:11:30279 extern int trust_executable_bit, has_symlinks;
280 if (!has_symlinks && S_ISREG(mode) &&
Linus Torvalds7a51ed62008-01-15 00:03:17281 ce && S_ISLNK(ce->ce_mode))
Johannes Sixt78a8d642007-03-02 21:11:30282 return ce->ce_mode;
Junio C Hamano185c9752007-02-17 06:43:48283 if (!trust_executable_bit && S_ISREG(mode)) {
Linus Torvalds7a51ed62008-01-15 00:03:17284 if (ce && S_ISREG(ce->ce_mode))
Junio C Hamano185c9752007-02-17 06:43:48285 return ce->ce_mode;
286 return create_ce_mode(0666);
287 }
288 return create_ce_mode(mode);
289}
Junio C Hamanod6b8fc32008-01-31 09:17:48290static inline int ce_to_dtype(const struct cache_entry *ce)
291{
292 unsigned ce_mode = ntohl(ce->ce_mode);
293 if (S_ISREG(ce_mode))
294 return DT_REG;
295 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
296 return DT_DIR;
297 else if (S_ISLNK(ce_mode))
298 return DT_LNK;
299 else
300 return DT_UNKNOWN;
301}
René Scharfeb90d9b82010-10-04 10:53:11302static inline unsigned int canon_mode(unsigned int mode)
303{
304 if (S_ISREG(mode))
305 return S_IFREG | ce_permissions(mode);
306 if (S_ISLNK(mode))
307 return S_IFLNK;
308 if (S_ISDIR(mode))
309 return S_IFDIR;
310 return S_IFGITLINK;
311}
Linus Torvaldse4479472005-04-17 05:26:31312
René Scharfeee7825b2011-10-25 18:00:04313#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
Linus Torvaldsf5cabd12005-04-16 04:45:38314
Nguyễn Thái Ngọc Duye636a7b2014-06-13 12:19:27315#define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
316#define CE_ENTRY_CHANGED (1 << 1)
317#define CE_ENTRY_REMOVED (1 << 2)
318#define CE_ENTRY_ADDED (1 << 3)
Nguyễn Thái Ngọc Duy6c306a32014-06-13 12:19:29319#define RESOLVE_UNDO_CHANGED (1 << 4)
Nguyễn Thái Ngọc Duya5400ef2014-06-13 12:19:31320#define CACHE_TREE_CHANGED (1 << 5)
Nguyễn Thái Ngọc Duyc18b80a2014-06-13 12:19:44321#define SPLIT_INDEX_ORDERED (1 << 6)
Nguyễn Thái Ngọc Duy1bbb3db2015-03-08 10:12:39322#define UNTRACKED_CHANGED (1 << 7)
Nguyễn Thái Ngọc Duye636a7b2014-06-13 12:19:27323
Nguyễn Thái Ngọc Duy5fc2fc82014-06-13 12:19:36324struct split_index;
Nguyễn Thái Ngọc Duy83c094a2015-03-08 10:12:33325struct untracked_cache;
326
Junio C Hamano228e94f2007-04-02 01:14:06327struct index_state {
328 struct cache_entry **cache;
Junio C Hamano9d227782012-04-04 16:12:43329 unsigned int version;
Junio C Hamano228e94f2007-04-02 01:14:06330 unsigned int cache_nr, cache_alloc, cache_changed;
Junio C Hamanocfc57892009-12-25 08:30:51331 struct string_list *resolve_undo;
Junio C Hamano228e94f2007-04-02 01:14:06332 struct cache_tree *cache_tree;
Nguyễn Thái Ngọc Duy5fc2fc82014-06-13 12:19:36333 struct split_index *split_index;
Kjetil Barvikfba2f382009-02-19 20:08:29334 struct cache_time timestamp;
Junio C Hamano913e0e92008-08-23 19:57:30335 unsigned name_hash_initialized : 1,
336 initialized : 1;
Karsten Blees8b013782013-11-14 19:21:58337 struct hashmap name_hash;
Karsten Bleese05881a2013-11-14 19:20:58338 struct hashmap dir_hash;
Yiannis Marangos426ddee2014-04-10 18:31:21339 unsigned char sha1[20];
Nguyễn Thái Ngọc Duy83c094a2015-03-08 10:12:33340 struct untracked_cache *untracked;
Junio C Hamano228e94f2007-04-02 01:14:06341};
342
343extern struct index_state the_index;
344
Linus Torvalds96872bc2008-03-21 20:16:24345/* Name hashing */
346extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
Karsten Blees20926782013-02-27 23:57:48347extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
348extern void free_name_hash(struct index_state *istate);
Linus Torvalds96872bc2008-03-21 20:16:24349
350
Junio C Hamano4aab5b42007-04-02 06:26:07351#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
Junio C Hamano228e94f2007-04-02 01:14:06352#define active_cache (the_index.cache)
353#define active_nr (the_index.cache_nr)
354#define active_alloc (the_index.cache_alloc)
355#define active_cache_changed (the_index.cache_changed)
356#define active_cache_tree (the_index.cache_tree)
Linus Torvaldse83c5162005-04-07 22:13:13357
Junio C Hamano4aab5b42007-04-02 06:26:07358#define read_cache() read_index(&the_index)
359#define read_cache_from(path) read_index_from(&the_index, (path))
Linus Torvalds671c9b72008-11-14 00:36:30360#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
Junio C Hamanofa7b3c22008-11-12 19:52:35361#define is_cache_unborn() is_index_unborn(&the_index)
Miklos Vajnae46bbcf2008-06-27 16:21:58362#define read_cache_unmerged() read_index_unmerged(&the_index)
Junio C Hamano4aab5b42007-04-02 06:26:07363#define discard_cache() discard_index(&the_index)
Daniel Barkalow94a57282008-02-07 16:40:13364#define unmerged_cache() unmerged_index(&the_index)
Junio C Hamano4aab5b42007-04-02 06:26:07365#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
366#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
Petr Baudis81dc2302008-07-21 00:25:56367#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
Junio C Hamano4aab5b42007-04-02 06:26:07368#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
369#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
Thomas Gummerer610d55a2016-09-14 21:07:47370#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
371#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
Thomas Gummererd9d70962016-09-14 21:07:46372#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
Matthieu Moy3deffc52009-08-21 08:57:59373#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
Junio C Hamano4bd5b7d2007-11-10 08:15:03374#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
375#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
Eric Sunshinedb5360f2013-09-17 07:06:14376#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
377#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
Jeff King98fa4732008-10-16 15:07:26378#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
Junio C Hamanocfc57892009-12-25 08:30:51379#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
Junio C Hamano8aa38562009-12-25 21:40:02380#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
Junio C Hamano4421a822009-12-25 19:57:11381#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
Lukas Fleischerff366822013-04-13 13:28:31382#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
Junio C Hamano4aab5b42007-04-02 06:26:07383#endif
Linus Torvaldse83c5162005-04-07 22:13:13384
Junio C Hamanoedaec3f2007-02-28 19:45:56385enum object_type {
386 OBJ_BAD = -1,
387 OBJ_NONE = 0,
388 OBJ_COMMIT = 1,
389 OBJ_TREE = 2,
390 OBJ_BLOB = 3,
391 OBJ_TAG = 4,
392 /* 5 for future expansion */
393 OBJ_OFS_DELTA = 6,
394 OBJ_REF_DELTA = 7,
Martin Koegler355885d2008-02-25 21:46:04395 OBJ_ANY,
Gary V. Vaughan4b055482010-05-14 09:31:35396 OBJ_MAX
Junio C Hamanoedaec3f2007-02-28 19:45:56397};
398
Junio C Hamanob45563a2007-12-01 06:22:38399static inline enum object_type object_type(unsigned int mode)
400{
401 return S_ISDIR(mode) ? OBJ_TREE :
402 S_ISGITLINK(mode) ? OBJ_COMMIT :
403 OBJ_BLOB;
404}
405
Jeff King2163e5d2013-03-08 09:29:08406/* Double-check local_repo_env below if you add to this list. */
Junio C Hamano8ac069a2005-05-10 05:57:58407#define GIT_DIR_ENVIRONMENT "GIT_DIR"
Nguyễn Thái Ngọc Duyc7b3a3d2014-11-30 08:24:36408#define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
Josh Tripletta1bea2c2011-07-05 17:54:44409#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
Matthias Lederhofer892c41b2007-06-06 07:10:42410#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
Jeff Kinga6f7f9a2013-03-08 09:30:25411#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
Junio C Hamano8ac069a2005-05-10 05:57:58412#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
Junio C Hamanod19938a2005-05-10 00:57:56413#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
Linus Torvaldsbb233d62005-04-21 17:55:18414#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
Junio C Hamano5da5c8f2005-07-30 07:58:28415#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
Nguyễn Thái Ngọc Duy069c0532013-12-05 13:02:45416#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
Junio C Hamanod4ebc362006-12-19 09:28:15417#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
418#define CONFIG_ENVIRONMENT "GIT_CONFIG"
Jeff King2b64fc82010-08-23 19:16:00419#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
Junio C Hamanod4ebc362006-12-19 09:28:15420#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
David Reiss0454dd92008-05-20 06:49:26421#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
Christian Couder6476b382009-11-18 06:50:58422#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
Mike Hommey58d121b2015-06-11 21:34:59423#define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
Junio C Hamanod0bfd022007-04-12 08:07:32424#define GITATTRIBUTES_FILE ".gitattributes"
425#define INFOATTRIBUTES_FILE "info/attributes"
Junio C Hamanof48fd682007-04-14 15:54:37426#define ATTRIBUTE_MACRO_PREFIX "[attr]"
Johannes Schindelina97a7462009-10-09 10:21:57427#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
428#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
Thomas Rast894a9d32010-03-12 17:04:26429#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
Thomas Rast6956f852010-03-12 17:04:32430#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
431#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
Jeff King823ab402012-12-19 22:37:30432#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
Nguyễn Thái Ngọc Duybd30c2e2013-07-14 08:36:08433#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
434#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
Nguyễn Thái Ngọc Duy93d93532013-07-14 08:36:09435#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
Linus Torvaldsbb233d62005-04-21 17:55:18436
Giuseppe Bilotta48a7c1c2010-02-24 23:34:14437/*
Jeff King2cd83d12013-03-08 09:32:22438 * This environment variable is expected to contain a boolean indicating
439 * whether we should or should not treat:
440 *
441 * GIT_DIR=foo.git git ...
442 *
443 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
444 * of this, but we use it internally to communicate to sub-processes that we
445 * are in a bare repo. If not set, defaults to true.
Giuseppe Bilotta48a7c1c2010-02-24 23:34:14446 */
Jeff King2cd83d12013-03-08 09:32:22447#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
448
449/*
Jeff King2163e5d2013-03-08 09:29:08450 * Repository-local GIT_* environment variables; these will be cleared
451 * when git spawns a sub-process that runs inside another repository.
452 * The array is NULL-terminated, which makes it easy to pass in the "env"
453 * parameter of a run-command invocation, or to do a simple walk.
Giuseppe Bilotta48a7c1c2010-02-24 23:34:14454 */
Jeff King2163e5d2013-03-08 09:29:08455extern const char * const local_repo_env[];
Giuseppe Bilotta48a7c1c2010-02-24 23:34:14456
Junio C Hamano7d1864c2007-01-07 10:00:28457extern int is_bare_repository_cfg;
458extern int is_bare_repository(void);
Johannes Schindelin68025632007-01-20 02:09:34459extern int is_inside_git_dir(void);
Johannes Schindeline90fdc32007-08-01 00:30:14460extern char *git_work_tree_cfg;
Matthias Lederhofer892c41b2007-06-06 07:10:42461extern int is_inside_work_tree(void);
Pierre Habouzitc5fba162006-08-23 10:39:11462extern const char *get_git_dir(void);
Nguyễn Thái Ngọc Duyc7b3a3d2014-11-30 08:24:36463extern const char *get_git_common_dir(void);
Junio C Hamano8ac069a2005-05-10 05:57:58464extern char *get_object_directory(void);
Junio C Hamano8ac069a2005-05-10 05:57:58465extern char *get_index_file(void);
Junio C Hamano5da5c8f2005-07-30 07:58:28466extern char *get_graft_file(void);
Johannes Schindelind7ac12b2007-08-01 00:29:38467extern int set_git_dir(const char *path);
Max Kirillov11f9dd72015-09-13 22:17:42468extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
Nguyễn Thái Ngọc Duy31e26eb2014-11-30 08:24:44469extern int get_common_dir(struct strbuf *sb, const char *gitdir);
Josh Tripletta1bea2c2011-07-05 17:54:44470extern const char *get_git_namespace(void);
471extern const char *strip_namespace(const char *namespaced_ref);
Johannes Schindeline90fdc32007-08-01 00:30:14472extern const char *get_git_work_tree(void);
Erik Elfströma93beda2015-06-09 18:24:35473
Jeff Kingffd036b2016-01-22 22:27:33474/*
475 * Return true if the given path is a git directory; note that this _just_
476 * looks at the directory itself. If you want to know whether "foo/.git"
477 * is a repository, you must feed that path, not just "foo".
478 */
479extern int is_git_directory(const char *path);
480
481/*
482 * Return 1 if the given path is the root of a git repository or
483 * submodule, else 0. Will not return 1 for bare repositories with the
484 * exception of creating a bare repository in "foo/.git" and calling
485 * is_git_repository("foo").
486 *
487 * If we run into read errors, we err on the side of saying "yes, it is",
488 * as we usually consider sub-repos precious, and would prefer to err on the
489 * side of not disrupting or deleting them.
490 */
491extern int is_nonbare_repository_dir(struct strbuf *path);
492
Erik Elfströma93beda2015-06-09 18:24:35493#define READ_GITFILE_ERR_STAT_FAILED 1
494#define READ_GITFILE_ERR_NOT_A_FILE 2
495#define READ_GITFILE_ERR_OPEN_FAILED 3
496#define READ_GITFILE_ERR_READ_FAILED 4
497#define READ_GITFILE_ERR_INVALID_FORMAT 5
498#define READ_GITFILE_ERR_NO_PATH 6
499#define READ_GITFILE_ERR_NOT_A_REPO 7
Erik Elfström921bdd92015-06-15 19:39:52500#define READ_GITFILE_ERR_TOO_LARGE 8
Erik Elfströma93beda2015-06-09 18:24:35501extern const char *read_gitfile_gently(const char *path, int *return_error_code);
502#define read_gitfile(path) read_gitfile_gently((path), NULL)
Fredrik Gustafssonabc06822011-08-15 21:17:46503extern const char *resolve_gitdir(const char *suspect);
Daniel Barkalow19757d82008-04-27 17:39:21504extern void set_git_work_tree(const char *tree);
Junio C Hamano8ac069a2005-05-10 05:57:58505
506#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
Linus Torvaldsbb233d62005-04-21 17:55:18507
Junio C Hamano6b5ee132005-09-21 07:00:47508extern const char **get_pathspec(const char *prefix, const char **pathspec);
Mike Hommey59f0f2f2007-11-03 11:23:11509extern void setup_work_tree(void);
Junio C Hamano4ca06602005-11-26 07:14:15510extern const char *setup_git_directory_gently(int *);
Linus Torvaldsd288a702005-08-17 01:06:34511extern const char *setup_git_directory(void);
Nguyễn Thái Ngọc Duyedc54fb2010-11-11 14:08:03512extern char *prefix_path(const char *prefix, int len, const char *path);
Nguyễn Thái Ngọc Duy645a29c2013-07-14 08:36:03513extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
Junio C Hamano4ca06602005-11-26 07:14:15514extern const char *prefix_filename(const char *prefix, int len, const char *path);
Junio C Hamanoc6e8c802009-10-18 07:27:24515extern int check_filename(const char *prefix, const char *name);
Matthieu Moy023e37c2012-06-18 18:18:21516extern void verify_filename(const char *prefix,
517 const char *name,
518 int diagnose_misspelt_rev);
Junio C Hamanoea92f412006-04-26 22:09:27519extern void verify_non_filename(const char *prefix, const char *name);
Jeff King546e0fd2012-06-21 18:09:50520extern int path_inside_repo(const char *prefix, const char *path);
Linus Torvaldsd288a702005-08-17 01:06:34521
Daniel Barkalowf225aeb2008-04-27 17:39:27522#define INIT_DB_QUIET 0x0001
523
Nguyễn Thái Ngọc Duyb57fb802011-03-19 15:16:56524extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
Daniel Barkalowf225aeb2008-04-27 17:39:27525extern int init_db(const char *template_dir, unsigned int flags);
526
Thomas Rast1d999dd2013-07-16 09:27:36527extern void sanitize_stdfds(void);
Nguyễn Thái Ngọc Duyde0957c2014-02-08 07:08:51528extern int daemonize(void);
Thomas Rast1d999dd2013-07-16 09:27:36529
Linus Torvaldse83c5162005-04-07 22:13:13530#define alloc_nr(x) (((x)+16)*3/2)
531
Jeff King6815e562007-06-11 13:39:44532/*
533 * Realloc the buffer pointed at by variable 'x' so that it can hold
534 * at least 'nr' entries; the number of entries currently allocated
535 * is 'alloc', using the standard growing factor alloc_nr() macro.
536 *
Jonathan Nieder01f6fd42010-10-08 16:46:59537 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
Jeff King6815e562007-06-11 13:39:44538 */
539#define ALLOC_GROW(x, nr, alloc) \
540 do { \
Jeff Kingc927e6c2007-06-16 22:37:39541 if ((nr) > alloc) { \
Junio C Hamano4234a762007-06-12 05:10:55542 if (alloc_nr(alloc) < (nr)) \
543 alloc = (nr); \
544 else \
545 alloc = alloc_nr(alloc); \
René Scharfe2756ca42014-09-16 18:56:57546 REALLOC_ARRAY(x, alloc); \
Jeff King6815e562007-06-11 13:39:44547 } \
Jonathan Nieder98746062010-08-12 22:11:15548 } while (0)
Jeff King6815e562007-06-11 13:39:44549
Linus Torvalds734aab72005-04-09 16:48:20550/* Initialize and use the cache information */
Nguyễn Thái Ngọc Duy03b86642014-06-13 12:19:23551struct lock_file;
Junio C Hamano4aab5b42007-04-02 06:26:07552extern int read_index(struct index_state *);
Nguyễn Thái Ngọc Duy5ab2a2d2013-07-14 08:35:49553extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
Nguyễn Thái Ngọc Duy3e52f702014-06-13 12:19:51554extern int do_read_index(struct index_state *istate, const char *path,
555 int must_exist); /* for testting only! */
Junio C Hamano4aab5b42007-04-02 06:26:07556extern int read_index_from(struct index_state *, const char *path);
Junio C Hamanofa7b3c22008-11-12 19:52:35557extern int is_index_unborn(struct index_state *);
Miklos Vajnae46bbcf2008-06-27 16:21:58558extern int read_index_unmerged(struct index_state *);
Nguyễn Thái Ngọc Duy03b86642014-06-13 12:19:23559#define COMMIT_LOCK (1 << 0)
560#define CLOSE_LOCK (1 << 1)
561extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
Junio C Hamano4aab5b42007-04-02 06:26:07562extern int discard_index(struct index_state *);
Linus Torvaldsd1f128b2008-03-06 20:46:09563extern int unmerged_index(const struct index_state *);
Linus Torvalds8dcf39c2006-05-18 19:07:31564extern int verify_path(const char *path);
David Turner41284eb2015-10-21 17:54:11565extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
566extern void adjust_dirname_case(struct index_state *istate, char *name);
Eric Sunshinedb5360f2013-09-17 07:06:14567extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
Linus Torvaldsd1f128b2008-03-06 20:46:09568extern int index_name_pos(const struct index_state *, const char *name, int namelen);
Junio C Hamano192268c2005-05-08 04:55:21569#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
570#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
Junio C Hamanob1557252005-06-25 09:25:29571#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
Junio C Hamanoaf3785d2007-08-09 20:42:50572#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
Junio C Hamano39425812008-08-21 08:44:53573#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
Nguyễn Thái Ngọc Duyce7c6142014-06-13 12:19:42574#define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
Junio C Hamano4aab5b42007-04-02 06:26:07575extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
Petr Baudis81dc2302008-07-21 00:25:56576extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
Junio C Hamano4aab5b42007-04-02 06:26:07577extern int remove_index_entry_at(struct index_state *, int pos);
Kjetil Barvik36419c82009-02-18 22:18:03578extern void remove_marked_cache_entries(struct index_state *istate);
Junio C Hamano4aab5b42007-04-02 06:26:07579extern int remove_file_from_index(struct index_state *, const char *path);
Junio C Hamano38ed1d82008-05-21 19:04:34580#define ADD_CACHE_VERBOSE 1
581#define ADD_CACHE_PRETEND 2
Junio C Hamano01665922008-05-25 21:03:50582#define ADD_CACHE_IGNORE_ERRORS 4
Junio C Hamano041aee32008-07-21 08:24:17583#define ADD_CACHE_IGNORE_REMOVAL 8
Junio C Hamano39425812008-08-21 08:44:53584#define ADD_CACHE_INTENT 16
Thomas Gummerer610d55a2016-09-14 21:07:47585extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
586extern int add_file_to_index(struct index_state *, const char *path, int flags);
Brad King25762722014-01-27 14:45:08587extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
Thomas Gummererd9d70962016-09-14 21:07:46588extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
Nguyễn Thái Ngọc Duy9c5e6c82013-07-09 15:29:00589extern 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:09590extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
Jeff King98fa4732008-10-16 15:07:26591extern int index_name_is_other(const struct index_state *, const char *, int);
Lukas Fleischerff366822013-04-13 13:28:31592extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
Junio C Hamano4bd5b7d2007-11-10 08:15:03593
594/* do stat comparison even if CE_VALID is true */
595#define CE_MATCH_IGNORE_VALID 01
596/* do not check the contents but report dirty on racily-clean entries */
Nguyễn Thái Ngọc Duy56cac482009-12-14 11:43:58597#define CE_MATCH_RACY_IS_DIRTY 02
598/* do stat comparison even if CE_SKIP_WORKTREE is true */
599#define CE_MATCH_IGNORE_SKIP_WORKTREE 04
Brad King2e2e7ec2014-01-27 14:45:07600/* ignore non-existent files during stat update */
601#define CE_MATCH_IGNORE_MISSING 0x08
Brad King25762722014-01-27 14:45:08602/* enable stat refresh */
603#define CE_MATCH_REFRESH 0x10
René Scharfe21a6b9f2013-06-02 15:46:52604extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
605extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
Junio C Hamano4bd5b7d2007-11-10 08:15:03606
Junio C Hamanoc4ce46f2011-05-08 08:47:33607#define HASH_WRITE_OBJECT 1
608#define HASH_FORMAT_CHECK 2
609extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
610extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
Michael Haggertyc21d39d2013-06-20 08:37:50611
612/*
613 * Record to sd the data from st that we use to check whether a file
614 * might have changed.
615 */
616extern void fill_stat_data(struct stat_data *sd, struct stat *st);
617
618/*
619 * Return 0 if st is consistent with a file not having been changed
620 * since sd was filled. If there are differences, return a
621 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
622 * INODE_CHANGED, and DATA_CHANGED.
623 */
624extern int match_stat_data(const struct stat_data *sd, struct stat *st);
Nguyễn Thái Ngọc Duyed4efab2015-03-08 10:12:37625extern int match_stat_data_racy(const struct index_state *istate,
626 const struct stat_data *sd, struct stat *st);
Michael Haggertyc21d39d2013-06-20 08:37:50627
Junio C Hamano415e96c2005-05-15 21:23:12628extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
629
Linus Torvalds405e5b22006-05-19 16:56:35630#define REFRESH_REALLY 0x0001 /* ignore_valid */
631#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
632#define REFRESH_QUIET 0x0004 /* be quiet about it */
633#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
Junio C Hamano3f1b7b62008-07-20 06:25:00634#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
Matthieu Moy43673fd2009-08-21 08:57:58635#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
Nguyễn Thái Ngọc Duy9b2d6142013-07-14 08:35:54636extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
Junio C Hamano1335d762016-07-08 17:59:15637extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int);
Linus Torvalds405e5b22006-05-19 16:56:35638
Junio C Hamanoccdc4ec2011-03-21 17:16:10639extern void update_index_if_able(struct index_state *, struct lock_file *);
Junio C Hamano30ca07a2007-04-01 06:09:02640
641extern int hold_locked_index(struct lock_file *, int);
Junio C Hamano5e7f56a2007-04-01 06:27:41642extern void set_alternate_index_output(const char *);
Michael Haggerty697cc8e2014-10-01 10:28:42643
Junio C Hamano2ae1c532006-02-27 22:47:45644/* Environment bits from configuration mechanism */
Linus Torvalds17712992005-10-10 23:31:08645extern int trust_executable_bit;
Alex Riesen1ce47902008-07-28 06:31:28646extern int trust_ctime;
Robin Rosenbergc08e4d52013-01-22 07:49:22647extern int check_stat;
Junio C Hamano9378c162007-06-24 22:11:24648extern int quote_path_fully;
Johannes Sixt78a8d642007-03-02 21:11:30649extern int has_symlinks;
Linus Torvaldsdce96482010-10-28 18:28:04650extern int minimum_abbrev, default_abbrev;
Linus Torvalds0a9b88b2008-03-21 23:52:46651extern int ignore_case;
Junio C Hamano5f730762006-02-09 05:15:24652extern int assume_unchanged;
Junio C Hamano9f0bb902006-05-02 07:40:24653extern int prefer_symlink_refs;
Shawn Pearce6de08ae2006-05-17 09:55:40654extern int log_all_ref_updates;
Junio C Hamano2f8acdb2006-03-21 02:45:47655extern int warn_ambiguous_refs;
Jeff King25fba782013-07-12 06:20:05656extern int warn_on_object_refname_ambiguity;
Junio C Hamano2ae1c532006-02-27 22:47:45657extern const char *apply_default_whitespace;
Giuseppe Bilotta86c91f92009-08-04 11:16:49658extern const char *apply_default_ignorewhitespace;
Junio C Hamano64589a02011-10-06 18:22:24659extern const char *git_attributes_file;
Ævar Arnfjörð Bjarmason867ad082016-05-04 22:58:12660extern const char *git_hooks_path;
Joachim B Haga12f6c302006-07-03 20:11:47661extern int zlib_compression_level;
Dana How960ccca2007-05-09 20:56:50662extern int core_compression_level;
663extern int core_compression_seen;
Shawn O. Pearce60bb8b12006-12-23 07:34:28664extern size_t packed_git_window_size;
Shawn O. Pearce77ccc5b2006-12-23 07:33:35665extern size_t packed_git_limit;
Shawn O. Pearce18bdec12007-03-19 05:14:37666extern size_t delta_base_cache_limit;
Junio C Hamano15366282011-04-05 17:44:11667extern unsigned long big_file_threshold;
Junio C Hamano568508e2011-10-28 21:48:40668extern unsigned long pack_size_limit_cfg;
Michael Haggertyafc711b2014-02-18 11:24:55669
Jeff King7875acb2016-03-11 22:36:49670void set_shared_repository(int value);
671int get_shared_repository(void);
672
Michael Haggertyafc711b2014-02-18 11:24:55673/*
674 * Do replace refs need to be checked this run? This variable is
675 * initialized to true unless --no-replace-object is used or
676 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
677 * commands that do not want replace references to be active. As an
678 * optimization it is also set to false if replace references have
679 * been sought but there were none.
680 */
681extern int check_replace_refs;
Mike Hommey58d121b2015-06-11 21:34:59682extern char *git_replace_ref_base;
Michael Haggertyafc711b2014-02-18 11:24:55683
Linus Torvaldsaafe9fb2008-06-18 22:18:44684extern int fsync_object_files;
Linus Torvalds671c9b72008-11-14 00:36:30685extern int core_preload_index;
Nguyễn Thái Ngọc Duy08aefc92009-08-20 13:47:08686extern int core_apply_sparse_checkout;
Torsten Bögershausen76759c72012-07-08 13:50:25687extern int precomposed_unicode;
Jeff Kinga42643a2014-12-15 23:15:20688extern int protect_hfs;
Johannes Schindelin2b4c6ef2014-12-16 22:46:59689extern int protect_ntfs;
Nguyễn Thái Ngọc Duyc7b3a3d2014-11-30 08:24:36690extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
Linus Torvalds17712992005-10-10 23:31:08691
Junio C Hamanoeff80a92013-01-16 19:18:48692/*
Jeff King49672f22015-03-20 18:43:06693 * Include broken refs in all ref iterations, which will
694 * generally choke dangerous operations rather than letting
695 * them silently proceed without taking the broken ref into
696 * account.
697 */
698extern int ref_paranoia;
699
700/*
Junio C Hamanoeff80a92013-01-16 19:18:48701 * The character that begins a commented line in user-editable file
702 * that is subject to stripspace.
703 */
704extern char comment_line_char;
Nguyễn Thái Ngọc Duy84c9dc22014-05-17 01:52:23705extern int auto_comment_line_char;
Junio C Hamanoeff80a92013-01-16 19:18:48706
Johannes Schindelinf30afda2016-05-11 08:43:37707/* Windows only */
708enum hide_dotfiles_type {
709 HIDE_DOTFILES_FALSE = 0,
710 HIDE_DOTFILES_TRUE,
711 HIDE_DOTFILES_DOTGITONLY
712};
713extern enum hide_dotfiles_type hide_dotfiles;
714
Jay Soffian9ed36cf2008-02-19 16:24:37715enum branch_track {
Alex Riesen9188ed82008-08-21 17:23:20716 BRANCH_TRACK_UNSPECIFIED = -1,
Jay Soffian9ed36cf2008-02-19 16:24:37717 BRANCH_TRACK_NEVER = 0,
718 BRANCH_TRACK_REMOTE,
719 BRANCH_TRACK_ALWAYS,
720 BRANCH_TRACK_EXPLICIT,
Gary V. Vaughan4b055482010-05-14 09:31:35721 BRANCH_TRACK_OVERRIDE
Jay Soffian9ed36cf2008-02-19 16:24:37722};
723
Dustin Sallingsc998ae92008-05-10 22:36:29724enum rebase_setup_type {
725 AUTOREBASE_NEVER = 0,
726 AUTOREBASE_LOCAL,
727 AUTOREBASE_REMOTE,
Gary V. Vaughan4b055482010-05-14 09:31:35728 AUTOREBASE_ALWAYS
Dustin Sallingsc998ae92008-05-10 22:36:29729};
730
Finn Arne Gangstad52153742009-03-16 15:42:51731enum push_default_type {
Finn Arne Gangstad52153742009-03-16 15:42:51732 PUSH_DEFAULT_NOTHING = 0,
733 PUSH_DEFAULT_MATCHING,
Matthieu Moyb55e67752012-04-24 07:50:03734 PUSH_DEFAULT_SIMPLE,
Johan Herland53c40312011-02-16 00:54:24735 PUSH_DEFAULT_UPSTREAM,
Christopher Tiwaldf25950f2012-03-20 04:31:33736 PUSH_DEFAULT_CURRENT,
737 PUSH_DEFAULT_UNSPECIFIED
Finn Arne Gangstad52153742009-03-16 15:42:51738};
739
Jay Soffian9ed36cf2008-02-19 16:24:37740extern enum branch_track git_branch_track;
Dustin Sallingsc998ae92008-05-10 22:36:29741extern enum rebase_setup_type autorebase;
Finn Arne Gangstad52153742009-03-16 15:42:51742extern enum push_default_type push_default;
Jay Soffian9ed36cf2008-02-19 16:24:37743
Johannes Schindelin348df162009-04-27 22:32:25744enum object_creation_mode {
745 OBJECT_CREATION_USES_HARDLINKS = 0,
Gary V. Vaughan4b055482010-05-14 09:31:35746 OBJECT_CREATION_USES_RENAMES = 1
Johannes Schindelin348df162009-04-27 22:32:25747};
748
749extern enum object_creation_mode object_creation_mode;
Johannes Schindelinbe66a6c2009-04-25 09:57:14750
Johannes Schindelina97a7462009-10-09 10:21:57751extern char *notes_ref_name;
752
Johannes Schindelin7f3140c2009-07-23 15:33:49753extern int grafts_replace_parents;
754
Jeff King00a09d52015-06-23 10:53:58755/*
756 * GIT_REPO_VERSION is the version we write by default. The
757 * _READ variant is the highest number we know how to
758 * handle.
759 */
Junio C Hamanoab9cb762005-11-25 23:59:09760#define GIT_REPO_VERSION 0
Jeff King00a09d52015-06-23 10:53:58761#define GIT_REPO_VERSION_READ 1
Jeff King067fbd42015-06-23 10:54:11762extern int repository_format_precious_objects;
Jeff King4b0d1ee2016-03-11 22:36:45763
Jeff King2cc7c2c2016-03-11 22:37:07764struct repository_format {
765 int version;
766 int precious_objects;
767 int is_bare;
768 char *work_tree;
769 struct string_list unknown_extensions;
770};
771
772/*
773 * Read the repository format characteristics from the config file "path" into
774 * "format" struct. Returns the numeric version. On error, -1 is returned,
775 * format->version is set to -1, and all other fields in the struct are
776 * undefined.
777 */
778int read_repository_format(struct repository_format *format, const char *path);
779
780/*
781 * Verify that the repository described by repository_format is something we
782 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
783 * any errors encountered.
784 */
785int verify_repository_format(const struct repository_format *format,
786 struct strbuf *err);
787
Jeff King4b0d1ee2016-03-11 22:36:45788/*
789 * Check the repository format version in the path found in get_git_dir(),
790 * and die if it is a version we don't understand. Generally one would
791 * set_git_dir() before calling this, and use it only for "are we in a valid
792 * repo?".
793 */
794extern void check_repository_format(void);
Junio C Hamanoab9cb762005-11-25 23:59:09795
Linus Torvalds734aab72005-04-09 16:48:20796#define MTIME_CHANGED 0x0001
797#define CTIME_CHANGED 0x0002
798#define OWNER_CHANGED 0x0004
799#define MODE_CHANGED 0x0008
800#define INODE_CHANGED 0x0010
801#define DATA_CHANGED 0x0020
Kay Sievers8ae0a8c2005-05-05 12:38:25802#define TYPE_CHANGED 0x0040
Linus Torvaldse83c5162005-04-07 22:13:13803
Jeff King69ddd232015-08-10 09:32:07804/*
805 * Return a statically allocated filename, either generically (mkpath), in
806 * the repository directory (git_path), or in a submodule's repository
807 * directory (git_path_submodule). In all cases, note that the result
808 * may be overwritten by another call to _any_ of the functions. Consider
Jeff King07e30702015-08-10 09:36:27809 * using the safer "dup" or "strbuf" formats below (in some cases, the
810 * unsafe versions have already been removed).
Jeff King69ddd232015-08-10 09:32:07811 */
812extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
813extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
Nguyễn Thái Ngọc Duy15cdfea2016-04-22 13:01:25814extern const char *git_common_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
Jeff King69ddd232015-08-10 09:32:07815
Alex Riesen108bebe2008-10-26 21:59:13816extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
817 __attribute__((format (printf, 3, 4)));
Nguyễn Thái Ngọc Duy1a83c242014-11-30 08:24:28818extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
819 __attribute__((format (printf, 2, 3)));
Nguyễn Thái Ngọc Duy15cdfea2016-04-22 13:01:25820extern void strbuf_git_common_path(struct strbuf *sb, const char *fmt, ...)
821 __attribute__((format (printf, 2, 3)));
Jeff Kingbb3788c2015-09-24 21:05:40822extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
823 __attribute__((format (printf, 2, 3)));
Jeff Kingf5895fd2015-08-10 09:32:22824extern void strbuf_git_path_submodule(struct strbuf *sb, const char *path,
825 const char *fmt, ...)
826 __attribute__((format (printf, 3, 4)));
Alex Riesenaba13e72008-10-27 10:17:51827extern char *git_pathdup(const char *fmt, ...)
828 __attribute__((format (printf, 1, 2)));
Huynh Khoi Nguyen Nguyen21cf3222012-06-22 09:03:23829extern char *mkpathdup(const char *fmt, ...)
830 __attribute__((format (printf, 1, 2)));
Jeff Kingf5895fd2015-08-10 09:32:22831extern char *git_pathdup_submodule(const char *path, const char *fmt, ...)
Heiko Voigt0bad6112010-07-07 13:39:11832 __attribute__((format (printf, 2, 3)));
Alex Riesen108bebe2008-10-26 21:59:13833
Nguyễn Thái Ngọc Duy77a6d842014-11-30 08:24:54834extern void report_linked_checkout_garbage(void);
Heiko Voigt0bad6112010-07-07 13:39:11835
Michael Haggertyd40d5352014-02-21 16:32:06836/*
Jeff Kingf9327292015-08-10 09:38:57837 * You can define a static memoized git path like:
838 *
839 * static GIT_PATH_FUNC(git_path_foo, "FOO");
840 *
841 * or use one of the global ones below.
842 */
843#define GIT_PATH_FUNC(func, filename) \
844 const char *func(void) \
845 { \
846 static char *ret; \
847 if (!ret) \
848 ret = git_pathdup(filename); \
849 return ret; \
850 }
851
852const char *git_path_cherry_pick_head(void);
853const char *git_path_revert_head(void);
854const char *git_path_squash_msg(void);
855const char *git_path_merge_msg(void);
856const char *git_path_merge_rr(void);
857const char *git_path_merge_mode(void);
858const char *git_path_merge_head(void);
859const char *git_path_fetch_head(void);
860const char *git_path_shallow(void);
861
862/*
Michael Haggertyd40d5352014-02-21 16:32:06863 * Return the name of the file in the local object database that would
864 * be used to store a loose object with the specified sha1. The
865 * return value is a pointer to a statically allocated buffer that is
866 * overwritten each time the function is called.
867 */
Michael Haggerty30d6c6e2014-02-21 16:32:05868extern const char *sha1_file_name(const unsigned char *sha1);
Michael Haggertyd40d5352014-02-21 16:32:06869
870/*
871 * Return the name of the (local) packfile with the specified sha1 in
872 * its name. The return value is a pointer to memory that is
873 * overwritten each time this function is called.
874 */
barkalow@iabervon.orgbf592c52005-08-01 00:53:44875extern char *sha1_pack_name(const unsigned char *sha1);
Michael Haggertyd40d5352014-02-21 16:32:06876
877/*
878 * Return the name of the (local) pack index file with the specified
879 * sha1 in its name. The return value is a pointer to memory that is
880 * overwritten each time this function is called.
881 */
barkalow@iabervon.orgbf592c52005-08-01 00:53:44882extern char *sha1_pack_index_name(const unsigned char *sha1);
Michael Haggertyd40d5352014-02-21 16:32:06883
Jeff Kingaf49c6d2015-09-24 21:05:45884/*
885 * Return an abbreviated sha1 unique within this repository's object database.
886 * The result will be at least `len` characters long, and will be NUL
887 * terminated.
888 *
889 * The non-`_r` version returns a static buffer which will be overwritten by
890 * subsequent calls.
891 *
892 * The `_r` variant writes to a buffer supplied by the caller, which must be at
893 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
894 * written (excluding the NUL terminator).
895 *
896 * Note that while this version avoids the static buffer, it is not fully
897 * reentrant, as it calls into other non-reentrant git code.
898 */
899extern const char *find_unique_abbrev(const unsigned char *sha1, int len);
900extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len);
901
brian m. carlsonaa1c6fd2015-03-13 23:39:28902extern const unsigned char null_sha1[GIT_SHA1_RAWSZ];
brian m. carlson3e56e722015-12-06 22:16:35903extern const struct object_id null_oid;
Ingo Molnar1a812f32011-04-28 10:19:02904
David Rientjesa89fccd2006-08-17 18:54:57905static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
906{
Ingo Molnar1a812f32011-04-28 10:19:02907 int i;
908
brian m. carlsonaa1c6fd2015-03-13 23:39:28909 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
Ingo Molnar1a812f32011-04-28 10:19:02910 if (*sha1 != *sha2)
911 return *sha1 - *sha2;
912 }
913
914 return 0;
David Rientjesa89fccd2006-08-17 18:54:57915}
Ingo Molnar1a812f32011-04-28 10:19:02916
brian m. carlsonaa1c6fd2015-03-13 23:39:28917static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
918{
919 return hashcmp(oid1->hash, oid2->hash);
920}
921
Ingo Molnar1a812f32011-04-28 10:19:02922static inline int is_null_sha1(const unsigned char *sha1)
923{
924 return !hashcmp(sha1, null_sha1);
925}
926
brian m. carlsonaa1c6fd2015-03-13 23:39:28927static inline int is_null_oid(const struct object_id *oid)
928{
929 return !hashcmp(oid->hash, null_sha1);
930}
931
Shawn Pearcee7024962006-08-23 06:49:00932static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
933{
brian m. carlsonaa1c6fd2015-03-13 23:39:28934 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
Shawn Pearcee7024962006-08-23 06:49:00935}
brian m. carlsonaa1c6fd2015-03-13 23:39:28936
937static inline void oidcpy(struct object_id *dst, const struct object_id *src)
938{
939 hashcpy(dst->hash, src->hash);
940}
941
Junio C Hamanoa8e0d162006-08-23 20:57:23942static inline void hashclr(unsigned char *hash)
943{
brian m. carlsonaa1c6fd2015-03-13 23:39:28944 memset(hash, 0, GIT_SHA1_RAWSZ);
Junio C Hamanoa8e0d162006-08-23 20:57:23945}
Linus Torvaldse83c5162005-04-07 22:13:13946
brian m. carlsonaa1c6fd2015-03-13 23:39:28947static inline void oidclr(struct object_id *oid)
948{
949 hashclr(oid->hash);
950}
951
952
Jeff King14d9c572008-11-12 08:17:52953#define EMPTY_TREE_SHA1_HEX \
954 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
Jonathan Niederdab0d412011-02-07 08:17:27955#define EMPTY_TREE_SHA1_BIN_LITERAL \
Jeff King14d9c572008-11-12 08:17:52956 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
957 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
Jonathan Niederdab0d412011-02-07 08:17:27958#define EMPTY_TREE_SHA1_BIN \
959 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
Jeff King14d9c572008-11-12 08:17:52960
Jeff Kingf8582ca2012-03-22 18:53:39961#define EMPTY_BLOB_SHA1_HEX \
962 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
963#define EMPTY_BLOB_SHA1_BIN_LITERAL \
964 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
965 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
966#define EMPTY_BLOB_SHA1_BIN \
967 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
968
969static inline int is_empty_blob_sha1(const unsigned char *sha1)
970{
971 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
972}
973
Holger Eitzenbergerf2db68e2005-08-04 20:43:03974int git_mkstemp(char *path, size_t n, const char *template);
975
Matthieu Moyb862b612010-02-22 22:32:13976/* set default permissions by passing mode arguments to open(2) */
977int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
978int git_mkstemp_mode(char *pattern, int mode);
979
Heikki Orsila06cbe852008-04-16 08:34:24980/*
981 * NOTE NOTE NOTE!!
982 *
983 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
984 * not be changed. Old repositories have core.sharedrepository written in
985 * numeric format, and therefore these values are preserved for compatibility
986 * reasons.
987 */
Junio C Hamano94df2502006-06-10 06:09:49988enum sharedrepo {
Heikki Orsila06cbe852008-04-16 08:34:24989 PERM_UMASK = 0,
990 OLD_PERM_GROUP = 1,
991 OLD_PERM_EVERYBODY = 2,
992 PERM_GROUP = 0660,
Gary V. Vaughan4b055482010-05-14 09:31:35993 PERM_EVERYBODY = 0664
Junio C Hamano94df2502006-06-10 06:09:49994};
995int git_config_perm(const char *var, const char *value);
Torsten Bögershausen3a429d32013-03-30 09:53:32996int adjust_shared_perm(const char *path);
Michael Haggerty0be05212014-01-06 13:45:25997
998/*
999 * Create the directory containing the named path, using care to be
1000 * somewhat safe against races. Return one of the scld_error values
1001 * to indicate success/failure.
Michael Haggerty18d37e82014-01-06 13:45:271002 *
1003 * SCLD_VANISHED indicates that one of the ancestor directories of the
1004 * path existed at one point during the function call and then
1005 * suddenly vanished, probably because another process pruned the
1006 * directory while we were working. To be robust against this kind of
1007 * race, callers might want to try invoking the function again when it
1008 * returns SCLD_VANISHED.
Michael Haggertye95792e2016-04-24 02:34:121009 *
1010 * safe_create_leading_directories() temporarily changes path while it
1011 * is working but restores it before returning.
1012 * safe_create_leading_directories_const() doesn't modify path, even
1013 * temporarily.
Michael Haggerty0be05212014-01-06 13:45:251014 */
1015enum scld_error {
1016 SCLD_OK = 0,
1017 SCLD_FAILED = -1,
1018 SCLD_PERMS = -2,
Michael Haggerty18d37e82014-01-06 13:45:271019 SCLD_EXISTS = -3,
1020 SCLD_VANISHED = -4
Michael Haggerty0be05212014-01-06 13:45:251021};
1022enum scld_error safe_create_leading_directories(char *path);
1023enum scld_error safe_create_leading_directories_const(const char *path);
1024
Junio C Hamano90a64642011-03-11 00:02:501025int mkdir_in_gitdir(const char *path);
Matthieu Moy395de252009-11-17 17:24:251026extern char *expand_user_path(const char *path);
Erik Faye-Lund1c64b482011-10-04 20:02:001027const char *enter_repo(const char *path, int strict);
Johannes Schindeline5392c52007-08-01 00:28:591028static inline int is_absolute_path(const char *path)
1029{
Theo Niessink88135202011-05-27 16:00:381030 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
Johannes Schindeline5392c52007-08-01 00:28:591031}
Junio C Hamano90b4a712008-09-09 08:27:071032int is_directory(const char *);
Carlos Martín Nietoe2a57aa2011-03-17 11:26:461033const char *real_path(const char *path);
Michael Haggertye3e46cd2012-10-28 16:16:221034const char *real_path_if_valid(const char *path);
Carlos Martín Nietoe2a57aa2011-03-17 11:26:461035const char *absolute_path(const char *path);
Jiang Xin41894ae2013-10-14 02:29:401036const char *remove_leading_path(const char *in, const char *prefix);
Jiang Xine02ca722013-06-25 15:53:431037const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
Nguyễn Thái Ngọc Duy645a29c2013-07-14 08:36:031038int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
Johannes Sixtf3cad0a2009-02-07 15:08:281039int normalize_path_copy(char *dst, const char *src);
Michael Haggerty31171d92012-10-28 16:16:241040int longest_ancestor_length(const char *path, struct string_list *prefixes);
Johannes Schindelin4fcc86b2009-02-19 19:10:491041char *strip_path_suffix(const char *path, const char *suffix);
Shawn O. Pearce34b6cb82009-11-09 19:26:431042int daemon_avoid_alias(const char *path);
Johannes Schindelin1d1d69b2014-12-16 22:31:031043extern int is_ntfs_dotgit(const char *name);
Junio C Hamanob2cb9422005-07-06 08:11:521044
Paul Tanea192892015-04-21 04:06:271045/**
1046 * Return a newly allocated string with the evaluation of
1047 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1048 * "$HOME/.config/git/$filename". Return NULL upon error.
1049 */
1050extern char *xdg_config_home(const char *filename);
1051
Junio C Hamanoe1111ce2011-05-15 19:54:531052/* object replacement */
Christian Couderffe68cf2013-12-11 07:46:041053#define LOOKUP_REPLACE_OBJECT 1
Karthik Nayak46f03442015-05-03 14:29:591054#define LOOKUP_UNKNOWN_OBJECT 2
Junio C Hamano5bf29b92011-05-15 19:54:541055extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
Christian Couderf5552ae2009-01-23 09:07:011056static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
1057{
Christian Couderffe68cf2013-12-11 07:46:041058 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
Christian Couderf5552ae2009-01-23 09:07:011059}
Michael Haggerty1f91e792014-02-28 16:29:161060
1061/*
1062 * This internal function is only declared here for the benefit of
1063 * lookup_replace_object(). Please do not call it directly.
1064 */
Junio C Hamanoe1111ce2011-05-15 19:54:531065extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
Michael Haggerty1f91e792014-02-28 16:29:161066
1067/*
1068 * If object sha1 should be replaced, return the replacement object's
1069 * name (replaced recursively, if necessary). The return value is
1070 * either sha1 or a pointer to a permanently-allocated value. When
1071 * object replacement is suppressed, always return sha1.
1072 */
Junio C Hamanoe1111ce2011-05-15 19:54:531073static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1074{
Michael Haggertyafc711b2014-02-18 11:24:551075 if (!check_replace_refs)
Junio C Hamanoe1111ce2011-05-15 19:54:531076 return sha1;
1077 return do_lookup_replace_object(sha1);
1078}
Michael Haggerty1f91e792014-02-28 16:29:161079
Christian Couderbf93eea2013-12-11 07:46:061080static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
1081{
1082 if (!(flag & LOOKUP_REPLACE_OBJECT))
1083 return sha1;
1084 return lookup_replace_object(sha1);
1085}
Junio C Hamanoe1111ce2011-05-15 19:54:531086
Linus Torvaldse83c5162005-04-07 22:13:131087/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
Nicolas Pitre21666f12007-02-26 19:55:591088extern int sha1_object_info(const unsigned char *, unsigned long *);
Nicolas Pitrece9fbf12007-03-20 20:02:091089extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
Jeff Kingc00e6572010-04-02 00:03:181090extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
Eric Sunshine0c3db672015-05-04 07:25:151091extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);
Nicolas Pitre21666f12007-02-26 19:55:591092extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
Nicolas Pitrebbac7312008-05-14 05:32:481093extern int force_object_loose(const unsigned char *sha1, time_t mtime);
Vicent Martiec73f582013-10-24 18:01:471094extern int git_open_noatime(const char *name);
Junio C Hamanof0270ef2011-05-15 02:42:101095extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
Junio C Hamanoeb4f4072011-07-19 16:33:031096extern 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:101097extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
Daniel Barkalow8237b182005-04-24 01:47:231098
Nicolas Pitre0e8189e2008-10-31 15:31:081099/* global flag to enable extra checks when accessing packed objects */
1100extern int do_check_packed_object_crc;
1101
Jason McMullan5d6ccf52005-06-03 15:05:391102extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
Linus Torvaldse83c5162005-04-07 22:13:131103
Junio C Hamanocb5add52015-08-07 21:40:241104extern int finalize_object_file(const char *tmpfile, const char *filename);
Daniel Barkalow8237b182005-04-24 01:47:231105
Junio C Hamanocd673c12009-02-28 07:15:531106extern int has_sha1_pack(const unsigned char *sha1);
Michael Haggertyd40d5352014-02-21 16:32:061107
1108/*
1109 * Return true iff we have an object named sha1, whether local or in
1110 * an alternate object database, and whether packed or loose. This
1111 * function does not respect replace references.
Jeff King0eeb0772015-06-09 17:24:371112 *
1113 * If the QUICK flag is set, do not re-check the pack directory
1114 * when we cannot find the object (this means we may give a false
1115 * negative answer if another process is simultaneously repacking).
Michael Haggertyd40d5352014-02-21 16:32:061116 */
Jeff King0eeb0772015-06-09 17:24:371117#define HAS_SHA1_QUICK 0x1
1118extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1119static inline int has_sha1_file(const unsigned char *sha1)
1120{
1121 return has_sha1_file_with_flags(sha1, 0);
1122}
Michael Haggertyd40d5352014-02-21 16:32:061123
brian m. carlsonb419aa22015-11-10 02:22:191124/* Same as the above, except for struct object_id. */
1125extern int has_object_file(const struct object_id *oid);
1126
Michael Haggertyd40d5352014-02-21 16:32:061127/*
1128 * Return true iff an alternate object database has a loose object
1129 * with the specified name. This function does not respect replace
1130 * references.
1131 */
Brandon Casey0f4dc142008-11-10 05:59:571132extern int has_loose_object_nonlocal(const unsigned char *sha1);
Daniel Barkalow8237b182005-04-24 01:47:231133
barkalow@iabervon.orgbf592c52005-08-01 00:53:441134extern int has_pack_index(const unsigned char *sha1);
1135
Jeff King40d52ff2010-04-02 00:05:231136extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1137
Linus Torvalds192a6be2007-05-30 17:32:191138extern const signed char hexval_table[256];
1139static inline unsigned int hexval(unsigned char c)
Junio C Hamanoe49521b2006-09-20 23:04:461140{
1141 return hexval_table[c];
1142}
1143
René Scharfed2330972016-09-03 15:59:201144/*
1145 * Convert two consecutive hexadecimal digits into a char. Return a
1146 * negative value on error. Don't run over the end of short strings.
1147 */
1148static inline int hex2chr(const char *s)
1149{
1150 int val = hexval(s[0]);
1151 return (val < 0) ? val : (val << 4) | hexval(s[1]);
1152}
1153
Linus Torvaldse83c5162005-04-07 22:13:131154/* Convert to/from hex/sha1 representation */
Linus Torvaldsdce96482010-10-28 18:28:041155#define MINIMUM_ABBREV minimum_abbrev
1156#define DEFAULT_ABBREV default_abbrev
Junio C Hamano46a6c262006-01-25 09:03:181157
Clément Poulain573285e2010-06-09 17:02:061158struct object_context {
1159 unsigned char tree[20];
1160 char path[PATH_MAX];
1161 unsigned mode;
David Turnerc4ec9672015-05-20 17:03:391162 /*
1163 * symlink_path is only used by get_tree_entry_follow_symlinks,
1164 * and only for symlinks that point outside the repository.
1165 */
1166 struct strbuf symlink_path;
Clément Poulain573285e2010-06-09 17:02:061167};
1168
David Turnerc4ec9672015-05-20 17:03:391169#define GET_SHA1_QUIETLY 01
1170#define GET_SHA1_COMMIT 02
1171#define GET_SHA1_COMMITTISH 04
1172#define GET_SHA1_TREE 010
1173#define GET_SHA1_TREEISH 020
1174#define GET_SHA1_BLOB 040
1175#define GET_SHA1_FOLLOW_SYMLINKS 0100
1176#define GET_SHA1_ONLY_TO_DIE 04000
Junio C Hamano37c00e52012-06-18 18:32:031177
Linus Torvalds3c249c92005-05-01 23:36:561178extern int get_sha1(const char *str, unsigned char *sha1);
Junio C Hamanodaba53a2012-07-03 06:35:051179extern int get_sha1_commit(const char *str, unsigned char *sha1);
Junio C Hamanocd74e472012-07-02 19:04:521180extern int get_sha1_committish(const char *str, unsigned char *sha1);
Junio C Hamanodaba53a2012-07-03 06:35:051181extern int get_sha1_tree(const char *str, unsigned char *sha1);
1182extern int get_sha1_treeish(const char *str, unsigned char *sha1);
1183extern int get_sha1_blob(const char *str, unsigned char *sha1);
Junio C Hamano8c135ea2012-07-02 18:01:251184extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
Junio C Hamano33bd5982012-07-02 17:32:111185extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
Michael Haggertyd4e85a12011-09-23 13:38:361186
brian m. carlson2764fd92016-04-17 23:10:361187extern int get_oid(const char *str, struct object_id *oid);
1188
Junio C Hamano957d7402012-07-03 21:21:591189typedef int each_abbrev_fn(const unsigned char *sha1, void *);
1190extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
Michael Haggertyd4e85a12011-09-23 13:38:361191
1192/*
1193 * Try to read a SHA1 in hexadecimal format from the 40 characters
1194 * starting at hex. Write the 20-byte result to sha1 in binary form.
1195 * Return 0 on success. Reading stops if a NUL is encountered in the
1196 * input, so it is safe to pass this function an arbitrary
1197 * null-terminated string.
1198 */
Linus Torvalds197ee8c2005-04-09 19:09:271199extern int get_sha1_hex(const char *hex, unsigned char *sha1);
brian m. carlsonaa1c6fd2015-03-13 23:39:281200extern int get_oid_hex(const char *hex, struct object_id *sha1);
Michael Haggertyd4e85a12011-09-23 13:38:361201
Jeff Kingaf49c6d2015-09-24 21:05:451202/*
1203 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1204 * and writes the NUL-terminated output to the buffer `out`, which must be at
1205 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1206 * convenience.
1207 *
1208 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1209 * buffers, making it safe to make multiple calls for a single statement, like:
1210 *
1211 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1212 */
1213extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
brian m. carlson55c529a2016-06-24 23:09:191214extern char *oid_to_hex_r(char *out, const struct object_id *oid);
Linus Torvalds197ee8c2005-04-09 19:09:271215extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
brian m. carlsonaa1c6fd2015-03-13 23:39:281216extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
Michael Haggerty7cb36842011-09-15 21:10:421217
Felipe Contrerascf99a762013-09-02 06:34:291218extern int interpret_branch_name(const char *str, int len, struct strbuf *);
Junio C Hamano619a6442009-10-18 19:34:561219extern int get_sha1_mb(const char *str, unsigned char *sha1);
Junio C Hamanoe86eb662007-01-19 09:15:151220
Junio C Hamanoc847f532007-01-02 07:31:081221extern int validate_headref(const char *ref);
Linus Torvaldse83c5162005-04-07 22:13:131222
Linus Torvalds958ba6c2005-05-20 16:09:181223extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
Linus Torvalds0ab9e1e2008-03-06 02:25:101224extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
Jeremiah Mahlerccdd4a02014-06-20 02:06:441225extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
Thomas Gummererb60e1882012-07-11 09:22:371226extern 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:131227
Junio C Hamano40469ee2005-04-28 23:42:271228extern void *read_object_with_reference(const unsigned char *sha1,
Brian Gerstbf0f9102005-05-18 12:14:091229 const char *required_type,
Junio C Hamano40469ee2005-04-28 23:42:271230 unsigned long *size,
1231 unsigned char *sha1_ret);
Junio C Hamanof4913f92005-04-21 01:06:491232
Junio C Hamano81776312007-12-24 08:51:011233extern struct object *peel_to_type(const char *name, int namelen,
1234 struct object *o, enum object_type);
1235
Jeff Kinga5481a62015-06-25 16:55:021236struct date_mode {
1237 enum date_mode_type {
1238 DATE_NORMAL = 0,
1239 DATE_RELATIVE,
1240 DATE_SHORT,
Jeff Kinga5481a62015-06-25 16:55:021241 DATE_ISO8601,
1242 DATE_ISO8601_STRICT,
1243 DATE_RFC2822,
Jeff Kingaa1462c2015-06-25 16:55:451244 DATE_STRFTIME,
Jeff King642833d2016-07-22 19:51:491245 DATE_RAW,
1246 DATE_UNIX
Jeff Kinga5481a62015-06-25 16:55:021247 } type;
Jeff Kingaa1462c2015-06-25 16:55:451248 const char *strftime_fmt;
Jeff Kingadd00ba2015-09-03 21:48:591249 int local;
Junio C Hamano73013af2007-07-14 06:14:521250};
1251
Jeff Kinga5481a62015-06-25 16:55:021252/*
1253 * Convenience helper for passing a constant type, like:
1254 *
1255 * show_date(t, tz, DATE_MODE(NORMAL));
1256 */
1257#define DATE_MODE(t) date_mode_from_type(DATE_##t)
1258struct date_mode *date_mode_from_type(enum date_mode_type type);
1259
1260const char *show_date(unsigned long time, int timezone, const struct date_mode *mode);
Jonathan Nieder7d29afd2012-04-23 12:30:231261void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1262 struct strbuf *timebuf);
Jeff Kingc33ddc22014-08-27 07:57:081263int parse_date(const char *date, struct strbuf *out);
Jonathan Nieder9644c062010-07-15 16:22:571264int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
Junio C Hamano3d27b9b2013-04-17 22:38:081265int parse_expiry_date(const char *date, unsigned long *timestamp);
Jeff Kingc33ddc22014-08-27 07:57:081266void datestamp(struct strbuf *out);
Junio C Hamano93cfa7c2010-01-26 19:58:001267#define approxidate(s) approxidate_careful((s), NULL)
1268unsigned long approxidate_careful(const char *, int *);
Alex Riesen33012fc2009-08-31 02:26:051269unsigned long approxidate_relative(const char *date, const struct timeval *now);
Jeff Kinga5481a62015-06-25 16:55:021270void parse_date_format(const char *format, struct date_mode *mode);
Jeff King7ca36d92014-02-24 07:39:451271int date_overflows(unsigned long date);
Edgar Toernigecee9d92005-04-30 16:46:491272
Jeff Kingf9bc5732012-05-24 23:28:401273#define IDENT_STRICT 1
Jeff Kingb9f0ac12012-05-21 23:10:111274#define IDENT_NO_DATE 2
Jeff Kingc15e1982012-05-24 23:27:241275#define IDENT_NO_NAME 4
Junio C Hamano749be722006-02-19 04:31:051276extern const char *git_author_info(int);
1277extern const char *git_committer_info(int);
Junio C Hamano798123a2007-02-05 01:50:141278extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
Junio C Hamanod9ccfe72007-12-02 21:43:341279extern const char *fmt_name(const char *name, const char *email);
Matthieu Moy98305342014-07-25 19:11:341280extern const char *ident_default_name(void);
Jeff Kingbcb2b002012-05-21 23:09:431281extern const char *ident_default_email(void);
Jonathan Nieder44fcb492009-11-12 00:01:271282extern const char *git_editor(void);
Jonathan Nieder64778d22010-02-14 11:59:591283extern const char *git_pager(int stdout_is_tty);
Jeff King95979212012-05-21 23:09:541284extern int git_ident_config(const char *, const char *, void *);
Jeff King4d9c7e62016-08-01 19:37:001285extern void reset_ident_date(void);
Linus Torvalds6aa33f42005-07-12 18:49:271286
Junio C Hamano4b340cf2012-03-11 09:25:431287struct ident_split {
1288 const char *name_begin;
1289 const char *name_end;
1290 const char *mail_begin;
1291 const char *mail_end;
1292 const char *date_begin;
1293 const char *date_end;
1294 const char *tz_begin;
1295 const char *tz_end;
1296};
1297/*
1298 * Signals an success with 0, but time part of the result may be NULL
1299 * if the input lacks timestamp and zone
1300 */
1301extern int split_ident_line(struct ident_split *, const char *, int);
1302
Jeff King662cc302013-09-20 10:16:281303/*
Jeff Kingd1053242014-05-02 01:07:221304 * Like show_date, but pull the timestamp and tz parameters from
1305 * the ident_split. It will also sanity-check the values and produce
1306 * a well-known sentinel date if they appear bogus.
1307 */
Jeff Kinga5481a62015-06-25 16:55:021308const char *show_ident_date(const struct ident_split *id,
1309 const struct date_mode *mode);
Jeff Kingd1053242014-05-02 01:07:221310
1311/*
Jeff King662cc302013-09-20 10:16:281312 * Compare split idents for equality or strict ordering. Note that we
1313 * compare only the ident part of the line, ignoring any timestamp.
1314 *
1315 * Because there are two fields, we must choose one as the primary key; we
1316 * currently arbitrarily pick the email.
1317 */
1318extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1319
Linus Torvalds12dccc12005-06-06 04:59:541320struct checkout {
Nguyễn Thái Ngọc Duyd4a20242014-06-13 12:19:341321 struct index_state *istate;
Linus Torvalds12dccc12005-06-06 04:59:541322 const char *base_dir;
1323 int base_dir_len;
1324 unsigned force:1,
1325 quiet:1,
1326 not_new:1,
1327 refresh_cache:1;
1328};
1329
Junio C Hamanoaf2a6512013-10-23 17:52:421330#define TEMPORARY_FILENAME_LENGTH 25
Luiz Fernando N. Capitulinoefbc5832007-04-25 14:18:081331extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
Linus Torvaldsb9fd2842009-07-09 20:35:311332
1333struct cache_def {
Karsten Bleese7c73052014-07-04 22:41:461334 struct strbuf path;
Linus Torvaldsb9fd2842009-07-09 20:35:311335 int flags;
1336 int track_flags;
1337 int prefix_len_stat_func;
1338};
Karsten Bleese7c73052014-07-04 22:41:461339#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
Karsten Blees2a608392014-07-11 23:02:341340static inline void cache_def_clear(struct cache_def *cache)
Karsten Bleese7c73052014-07-04 22:41:461341{
1342 strbuf_release(&cache->path);
1343}
Linus Torvaldsb9fd2842009-07-09 20:35:311344
Kjetil Barvik57199892009-02-09 20:54:061345extern int has_symlink_leading_path(const char *name, int len);
Linus Torvaldsb9fd2842009-07-09 20:35:311346extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
Clemens Buchacherf66caaf2010-10-09 13:53:001347extern int check_leading_path(const char *name, int len);
Kjetil Barvik57199892009-02-09 20:54:061348extern int has_dirs_only_path(const char *name, int len, int prefix_len);
Kjetil Barvik78478922009-02-09 20:54:071349extern void schedule_dir_for_removal(const char *name, int len);
1350extern void remove_scheduled_dirs(void);
Linus Torvalds12dccc12005-06-06 04:59:541351
Junio C Hamano9a217f22005-06-28 21:56:571352extern struct alternate_object_database {
Junio C Hamanod5a63b92005-08-15 00:25:571353 struct alternate_object_database *next;
Junio C Hamano9a217f22005-06-28 21:56:571354 char *name;
Junio C Hamano8f1d2e62006-01-07 09:33:541355 char base[FLEX_ARRAY]; /* more */
Junio C Hamanod5a63b92005-08-15 00:25:571356} *alt_odb_list;
Junio C Hamano9a217f22005-06-28 21:56:571357extern void prepare_alt_odb(void);
Heiko Voigt5e736332012-05-14 16:24:451358extern void read_info_alternates(const char * relative_base, int depth);
Daniel Barkalowbef70b22008-04-17 23:32:301359extern void add_to_alternates_file(const char *reference);
Junio C Hamanod79796b2008-09-09 08:27:101360typedef int alt_odb_fn(struct alternate_object_database *, void *);
Jeff Kingfe1b2262014-10-15 22:33:131361extern int foreach_alt_odb(alt_odb_fn, void*);
Junio C Hamano9a217f22005-06-28 21:56:571362
Shawn O. Pearcec41ee582006-12-23 07:33:441363struct pack_window {
1364 struct pack_window *next;
1365 unsigned char *base;
1366 off_t offset;
1367 size_t len;
1368 unsigned int last_used;
1369 unsigned int inuse_cnt;
1370};
1371
Junio C Hamano9a217f22005-06-28 21:56:571372extern struct packed_git {
1373 struct packed_git *next;
Shawn O. Pearcec41ee582006-12-23 07:33:441374 struct pack_window *windows;
Shawn O. Pearce2dc3a232006-12-23 07:33:471375 off_t pack_size;
Nicolas Pitre57059092007-04-09 05:06:281376 const void *index_data;
1377 size_t index_size;
1378 uint32_t num_objects;
Nicolas Pitre8eca0b42008-06-24 01:23:391379 uint32_t num_bad_objects;
1380 unsigned char *bad_object_sha1;
Nicolas Pitre42873072007-03-16 20:42:501381 int index_version;
Nicolas Pitre57059092007-04-09 05:06:281382 time_t mtime;
Shawn O. Pearce9bc879c2006-12-23 07:34:011383 int pack_fd;
Brandon Casey8d259312008-11-12 17:59:031384 unsigned pack_local:1,
Shawn O. Pearced131b7a2011-03-02 18:01:541385 pack_keep:1,
Jeff Kingee1c6c32015-04-20 19:55:001386 freshened:1,
Shawn O. Pearced131b7a2011-03-02 18:01:541387 do_not_close:1;
barkalow@iabervon.orgbf592c52005-08-01 00:53:441388 unsigned char sha1[20];
Jeff King9d98bbf2015-12-21 06:20:331389 struct revindex_entry *revindex;
Junio C Hamano8f1d2e62006-01-07 09:33:541390 /* something like ".git/objects/pack/xxxxx.pack" */
1391 char pack_name[FLEX_ARRAY]; /* more */
Junio C Hamano9a217f22005-06-28 21:56:571392} *packed_git;
Junio C Hamanof3bf9222005-07-01 00:15:391393
Jeff Kinga73cdd22016-07-29 04:09:461394/*
1395 * A most-recently-used ordered version of the packed_git list, which can
1396 * be iterated instead of packed_git (and marked via mru_mark).
1397 */
1398struct mru;
1399extern struct mru *packed_git_mru;
1400
Junio C Hamanof3bf9222005-07-01 00:15:391401struct pack_entry {
Shawn O. Pearcec4001d92007-03-07 01:44:301402 off_t offset;
Junio C Hamanof3bf9222005-07-01 00:15:391403 unsigned char sha1[20];
1404 struct packed_git *p;
1405};
1406
Shawn O. Pearce7b644692010-04-19 14:23:081407extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
barkalow@iabervon.orgbf592c52005-08-01 00:53:441408
Junio C Hamano0a489b02015-08-13 18:02:521409/* A hook to report invalid files in pack directory */
1410#define PACKDIR_FILE_PACK 1
1411#define PACKDIR_FILE_IDX 2
1412#define PACKDIR_FILE_GARBAGE 4
1413extern void (*report_garbage)(unsigned seen_bits, const char *path);
Nguyễn Thái Ngọc Duy543c5ca2013-02-15 12:07:101414
Junio C Hamano9a217f22005-06-28 21:56:571415extern void prepare_packed_git(void);
Shawn Pearcefc04c412006-11-01 22:06:211416extern void reprepare_packed_git(void);
barkalow@iabervon.orgbf592c52005-08-01 00:53:441417extern void install_packed_git(struct packed_git *pack);
1418
Junio C Hamanoa6080a02007-06-07 07:04:011419extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
barkalow@iabervon.orgbf592c52005-08-01 00:53:441420 struct packed_git *packs);
1421
Chris Wedgwood276bc2c2007-01-17 06:28:021422extern void pack_report(void);
Michael Haggertyd40d5352014-02-21 16:32:061423
1424/*
1425 * mmap the index file for the specified packfile (if it is not
1426 * already mmapped). Return 0 on success.
1427 */
Shawn O. Pearced0798372007-05-26 05:24:191428extern int open_pack_index(struct packed_git *);
Michael Haggertyd40d5352014-02-21 16:32:061429
1430/*
1431 * munmap the index file for the specified packfile (if it is
1432 * currently mmapped).
1433 */
Shawn O. Pearcefa5fc152010-04-19 14:23:061434extern void close_pack_index(struct packed_git *);
Michael Haggertyd40d5352014-02-21 16:32:061435
Junio C Hamanoef49a7a2011-06-10 18:52:151436extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
Shawn O. Pearcec9ced052008-01-18 03:57:001437extern void close_pack_windows(struct packed_git *);
Johannes Schindelin38849a82015-10-06 13:18:341438extern void close_all_packs(void);
Shawn O. Pearce03e79c82006-12-23 07:34:081439extern void unuse_pack(struct pack_window **);
Shawn O. Pearce3d20c632009-02-10 21:36:121440extern void clear_delta_base_cache(void);
Jeff King48bcc1c2015-09-24 21:06:551441extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
Michael Haggertyd40d5352014-02-21 16:32:061442
1443/*
Jeff King47fe3f62016-02-25 14:22:521444 * Make sure that a pointer access into an mmap'd index file is within bounds,
1445 * and can provide at least 8 bytes of data.
1446 *
1447 * Note that this is only necessary for variable-length segments of the file
1448 * (like the 64-bit extended offset table), as we compare the size to the
1449 * fixed-length parts when we open the file.
1450 */
1451extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
1452
1453/*
Michael Haggertyd40d5352014-02-21 16:32:061454 * Return the SHA-1 of the nth object within the specified packfile.
1455 * Open the index if it is not already open. The return value points
1456 * at the SHA-1 within the mmapped index. Return NULL if there is an
1457 * error.
1458 */
1459extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1460
1461/*
1462 * Return the offset of the nth object within the specified packfile.
1463 * The index must already be opened.
1464 */
1465extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1466
1467/*
1468 * If the object named sha1 is present in the specified packfile,
1469 * return its offset within the packfile; otherwise, return 0.
1470 */
1471extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1472
Jeff King4c080182011-10-14 18:03:481473extern int is_pack_valid(struct packed_git *);
Shawn O. Pearcec4001d92007-03-07 01:44:301474extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
Nicolas Pitre09ded042008-10-29 23:02:461475extern 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:561476extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
Junio C Hamanof8c8abc2011-05-13 22:33:331477extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
Junio C Hamano9a217f22005-06-28 21:56:571478
Jeff King27e1e222014-10-15 22:38:551479/*
1480 * Iterate over the files in the loose-object parts of the object
1481 * directory "path", triggering the following callbacks:
1482 *
1483 * - loose_object is called for each loose object we find.
1484 *
1485 * - loose_cruft is called for any files that do not appear to be
1486 * loose objects. Note that we only look in the loose object
1487 * directories "objects/[0-9a-f]{2}/", so we will not report
1488 * "objects/foobar" as cruft.
1489 *
1490 * - loose_subdir is called for each top-level hashed subdirectory
1491 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1492 * after the objects in the directory are processed.
1493 *
1494 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1495 * will end the iteration.
Jeff Kinge6f875e2015-02-09 01:13:221496 *
1497 * In the "buf" variant, "path" is a strbuf which will also be used as a
1498 * scratch buffer, but restored to its original contents before
1499 * the function returns.
Jeff King27e1e222014-10-15 22:38:551500 */
1501typedef int each_loose_object_fn(const unsigned char *sha1,
1502 const char *path,
1503 void *data);
1504typedef int each_loose_cruft_fn(const char *basename,
1505 const char *path,
1506 void *data);
1507typedef int each_loose_subdir_fn(int nr,
1508 const char *path,
1509 void *data);
1510int for_each_loose_file_in_objdir(const char *path,
1511 each_loose_object_fn obj_cb,
1512 each_loose_cruft_fn cruft_cb,
1513 each_loose_subdir_fn subdir_cb,
1514 void *data);
Jeff Kinge6f875e2015-02-09 01:13:221515int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1516 each_loose_object_fn obj_cb,
1517 each_loose_cruft_fn cruft_cb,
1518 each_loose_subdir_fn subdir_cb,
1519 void *data);
Jeff King27e1e222014-10-15 22:38:551520
Jeff King660c8892014-10-15 22:41:211521/*
1522 * Iterate over loose and packed objects in both the local
Jeff King1385bb72015-03-27 11:32:411523 * repository and any alternates repositories (unless the
1524 * LOCAL_ONLY flag is set).
Jeff King660c8892014-10-15 22:41:211525 */
Jeff King1385bb72015-03-27 11:32:411526#define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
Jeff King660c8892014-10-15 22:41:211527typedef int each_packed_object_fn(const unsigned char *sha1,
1528 struct packed_git *pack,
1529 uint32_t pos,
1530 void *data);
Jeff King1385bb72015-03-27 11:32:411531extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1532extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
Jeff King660c8892014-10-15 22:41:211533
Junio C Hamano9a490592011-05-12 22:51:381534struct object_info {
1535 /* Request */
Jeff King5b086402013-07-12 06:34:571536 enum object_type *typep;
Junio C Hamano9a490592011-05-12 22:51:381537 unsigned long *sizep;
Nguyễn Thái Ngọc Duy166df262016-07-13 15:43:591538 off_t *disk_sizep;
Jeff King5d642e72013-12-21 14:24:201539 unsigned char *delta_base_sha1;
Karthik Nayak46f03442015-05-03 14:29:591540 struct strbuf *typename;
Junio C Hamano9a490592011-05-12 22:51:381541
1542 /* Response */
1543 enum {
1544 OI_CACHED,
1545 OI_LOOSE,
Junio C Hamano5266d362011-05-13 20:20:431546 OI_PACKED,
1547 OI_DBCACHED
Junio C Hamano9a490592011-05-12 22:51:381548 } whence;
1549 union {
1550 /*
1551 * struct {
1552 * ... Nothing to expose in this case
1553 * } cached;
1554 * struct {
1555 * ... Nothing to expose in this case
1556 * } loose;
1557 */
1558 struct {
1559 struct packed_git *pack;
1560 off_t offset;
1561 unsigned int is_delta;
1562 } packed;
1563 } u;
1564};
Christian Couderde7b5d62013-12-11 07:46:071565extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
Junio C Hamano9a217f22005-06-28 21:56:571566
Junio C Hamano8f3f9b02005-07-24 00:54:411567/* Dumb servers support */
1568extern int update_server_info(int);
1569
Michael J Gruber7a397412011-05-17 15:38:521570/* git_config_parse_key() returns these negated: */
1571#define CONFIG_INVALID_KEY 1
1572#define CONFIG_NO_SECTION_OR_NAME 2
Patrick Steinhardt30598ad2016-02-22 11:23:351573/* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */
Michael J Gruber7a397412011-05-17 15:38:521574#define CONFIG_NO_LOCK -1
1575#define CONFIG_INVALID_FILE 3
1576#define CONFIG_NO_WRITE 4
1577#define CONFIG_NOTHING_SET 5
1578#define CONFIG_INVALID_PATTERN 6
Junio C Hamano9409c7a2012-07-29 20:43:211579#define CONFIG_GENERIC_ERROR 7
Michael J Gruber7a397412011-05-17 15:38:521580
Jeff Kingc1063be2014-08-19 06:20:001581#define CONFIG_REGEX_NONE ((void *)1)
1582
Kirill A. Shutemovc8985ce2014-02-18 22:58:541583struct git_config_source {
Kirill A. Shutemov3caec732014-02-18 22:58:551584 unsigned int use_stdin:1;
Kirill A. Shutemovc8985ce2014-02-18 22:58:541585 const char *file;
1586 const char *blob;
1587};
1588
Vasco Almeida1b8132d2016-07-28 13:14:031589enum config_origin_type {
1590 CONFIG_ORIGIN_BLOB,
1591 CONFIG_ORIGIN_FILE,
1592 CONFIG_ORIGIN_STDIN,
1593 CONFIG_ORIGIN_SUBMODULE_BLOB,
1594 CONFIG_ORIGIN_CMDLINE
1595};
1596
Johannes Schindelinef90d6d2008-05-14 17:46:531597typedef int (*config_fn_t)(const char *, const char *, void *);
1598extern int git_default_config(const char *, const char *, void *);
1599extern int git_config_from_file(config_fn_t fn, const char *, void *);
Vasco Almeida1b8132d2016-07-28 13:14:031600extern int git_config_from_mem(config_fn_t fn, const enum config_origin_type,
Lars Schneider473166b2016-02-19 09:16:011601 const char *name, const char *buf, size_t len, void *data);
Jeff King2b64fc82010-08-23 19:16:001602extern void git_config_push_parameter(const char *text);
Thomas Rastb3d83d92010-05-21 10:07:471603extern int git_config_from_parameters(config_fn_t fn, void *data);
Tanay Abhraaace4382014-08-07 11:59:151604extern void git_config(config_fn_t fn, void *);
Jeff King9b25a0b2012-02-06 09:54:041605extern int git_config_with_options(config_fn_t fn, void *,
Kirill A. Shutemovc8985ce2014-02-18 22:58:541606 struct git_config_source *config_source,
Heiko Voigt1bc88812013-07-11 22:46:471607 int respect_includes);
Brian Downing0b87b6e2007-07-12 13:32:261608extern int git_parse_ulong(const char *, unsigned long *);
Dave Borowitz9a549d42015-08-19 15:26:441609extern int git_parse_maybe_bool(const char *);
Linus Torvalds17712992005-10-10 23:31:081610extern int git_config_int(const char *, const char *);
Jeff King00160242013-09-08 08:40:021611extern int64_t git_config_int64(const char *, const char *);
Brian Downing0b87b6e2007-07-12 13:32:261612extern unsigned long git_config_ulong(const char *, const char *);
Junio C Hamanoa53f2ec2008-04-13 01:33:311613extern int git_config_bool_or_int(const char *, const char *, int *);
Linus Torvalds17712992005-10-10 23:31:081614extern int git_config_bool(const char *, const char *);
Junio C Hamano8420ccd2010-02-17 07:59:461615extern int git_config_maybe_bool(const char *, const char *);
Christian Couderea5105a2008-02-16 05:00:241616extern int git_config_string(const char **, const char *, const char *);
Matthieu Moy395de252009-11-17 17:24:251617extern int git_config_pathname(const char **, const char *, const char *);
Patrick Steinhardt30598ad2016-02-22 11:23:351618extern int git_config_set_in_file_gently(const char *, const char *, const char *);
Patrick Steinhardt3d180642016-02-22 11:23:361619extern void git_config_set_in_file(const char *, const char *, const char *);
Patrick Steinhardt30598ad2016-02-22 11:23:351620extern int git_config_set_gently(const char *, const char *);
Patrick Steinhardt3d180642016-02-22 11:23:361621extern void git_config_set(const char *, const char *);
Libor Pechacekb09c53a2011-01-30 19:40:411622extern int git_config_parse_key(const char *, char **, int *);
Jeff King9e9de182015-08-24 06:11:331623extern int git_config_key_is_valid(const char *key);
Patrick Steinhardt30598ad2016-02-22 11:23:351624extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);
Patrick Steinhardt3d180642016-02-22 11:23:361625extern void git_config_set_multivar(const char *, const char *, const char *, int);
Patrick Steinhardt30598ad2016-02-22 11:23:351626extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
Patrick Steinhardt3d180642016-02-22 11:23:361627extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
Johannes Schindelin0667fcf2006-12-16 14:14:141628extern int git_config_rename_section(const char *, const char *);
Jeff King42bd39b2012-02-16 08:04:251629extern int git_config_rename_section_in_file(const char *, const char *, const char *);
Johannes Sixt506b17b2007-11-13 20:05:051630extern const char *git_etc_gitconfig(void);
Lars R. Damerow0ef37162010-03-17 19:55:511631extern int git_env_bool(const char *, int);
Steffen Prohaska23b0c472014-08-26 15:23:211632extern unsigned long git_env_ulong(const char *, unsigned long);
Jeff Kingab88c362008-02-06 10:11:181633extern int git_config_system(void);
Junio C Hamano40ea4ed2008-02-11 18:41:181634extern int config_error_nonbool(const char *);
Jeff Kingff0a80a2014-05-06 15:17:501635#if defined(__GNUC__)
Jeff King87fe5df2014-05-06 15:14:421636#define config_error_nonbool(s) (config_error_nonbool(s), const_error())
Jeff Kinga469a102012-12-15 17:42:101637#endif
Pat Notza6fa5992010-11-02 19:59:071638extern const char *get_log_output_encoding(void);
1639extern const char *get_commit_output_encoding(void);
1640
Jeff King24968442011-06-09 15:56:421641extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
Jeff King9acc5912016-05-18 22:44:231642
1643enum config_scope {
1644 CONFIG_SCOPE_UNKNOWN = 0,
1645 CONFIG_SCOPE_SYSTEM,
1646 CONFIG_SCOPE_GLOBAL,
1647 CONFIG_SCOPE_REPO,
1648 CONFIG_SCOPE_CMDLINE,
1649};
1650
1651extern enum config_scope current_config_scope(void);
Lars Schneider473166b2016-02-19 09:16:011652extern const char *current_config_origin_type(void);
1653extern const char *current_config_name(void);
Jeff King24968442011-06-09 15:56:421654
Jeff King9b25a0b2012-02-06 09:54:041655struct config_include_data {
1656 int depth;
1657 config_fn_t fn;
1658 void *data;
1659};
1660#define CONFIG_INCLUDE_INIT { 0 }
1661extern int git_config_include(const char *name, const char *value, void *data);
Linus Torvalds17712992005-10-10 23:31:081662
Jeff King1b86bbb2013-01-23 06:23:051663/*
1664 * Match and parse a config key of the form:
1665 *
1666 * section.(subsection.)?key
1667 *
1668 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1669 * we return -1 if it does not match, 0 otherwise. The subsection and key
1670 * out-parameters are filled by the function (and subsection is NULL if it is
1671 * missing).
1672 */
1673extern int parse_config_key(const char *var,
1674 const char *section,
1675 const char **subsection, int *subsection_len,
1676 const char **key);
1677
Tanay Abhra155ef252014-08-07 11:59:171678struct config_set_element {
1679 struct hashmap_entry ent;
1680 char *key;
1681 struct string_list value_list;
1682};
1683
1684struct configset_list_item {
1685 struct config_set_element *e;
1686 int value_index;
1687};
1688
1689/*
1690 * the contents of the list are ordered according to their
1691 * position in the config files and order of parsing the files.
1692 * (i.e. key-value pair at the last position of .git/config will
1693 * be at the last item of the list)
1694 */
1695struct configset_list {
1696 struct configset_list_item *items;
1697 unsigned int nr, alloc;
1698};
1699
Tanay Abhra3c8687a2014-07-28 10:10:381700struct config_set {
1701 struct hashmap config_hash;
1702 int hash_initialized;
Tanay Abhra155ef252014-08-07 11:59:171703 struct configset_list list;
Tanay Abhra3c8687a2014-07-28 10:10:381704};
1705
1706extern void git_configset_init(struct config_set *cs);
1707extern int git_configset_add_file(struct config_set *cs, const char *filename);
1708extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
1709extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
1710extern void git_configset_clear(struct config_set *cs);
1711extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
1712extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
1713extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
1714extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
1715extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
1716extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
1717extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
1718extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
1719
1720extern int git_config_get_value(const char *key, const char **value);
1721extern const struct string_list *git_config_get_value_multi(const char *key);
1722extern void git_config_clear(void);
1723extern void git_config_iter(config_fn_t fn, void *data);
1724extern int git_config_get_string_const(const char *key, const char **dest);
1725extern int git_config_get_string(const char *key, char **dest);
1726extern int git_config_get_int(const char *key, int *dest);
1727extern int git_config_get_ulong(const char *key, unsigned long *dest);
1728extern int git_config_get_bool(const char *key, int *dest);
1729extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
1730extern int git_config_get_maybe_bool(const char *key, int *dest);
1731extern int git_config_get_pathname(const char *key, const char **dest);
Christian Couder435ec092016-01-27 06:58:051732extern int git_config_get_untracked_cache(void);
Tanay Abhra3c8687a2014-07-28 10:10:381733
Christian Couderdae6c322016-01-27 06:58:061734/*
1735 * This is a hack for test programs like test-dump-untracked-cache to
1736 * ensure that they do not modify the untracked cache when reading it.
1737 * Do not use it otherwise!
1738 */
1739extern int ignore_untracked_cache_config;
Matthias Lederhoferaa086eb2006-07-29 22:27:431740
Tanay Abhra3df8fd62014-08-07 11:59:141741struct key_value_info {
1742 const char *filename;
1743 int linenr;
Vasco Almeida1b8132d2016-07-28 13:14:031744 enum config_origin_type origin_type;
Jeff King9acc5912016-05-18 22:44:231745 enum config_scope scope;
Tanay Abhra3df8fd62014-08-07 11:59:141746};
1747
Tanay Abhra5a80e972014-08-07 11:59:161748extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
1749extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
1750
Jeff Kingd6991ce2012-11-15 00:34:131751extern int committer_ident_sufficiently_given(void);
Linus Torvaldse1b10392005-10-12 01:47:341752extern int author_ident_sufficiently_given(void);
Shawn O. Pearce1a8f2742007-03-12 19:33:181753
Shawn O. Pearce3a556022007-03-07 01:44:171754extern const char *git_commit_encoding;
Marius Storm-Olsend551a482009-02-08 14:34:271755extern const char *git_log_output_encoding;
Junio C Hamano4e72dce2005-11-28 00:09:401756extern const char *git_mailmap_file;
Theodore Ts'o06f59e92007-06-29 17:40:461757extern const char *git_mailmap_blob;
1758
Junio C Hamanof3123c42005-10-22 08:28:131759/* IO helper functions */
Daniel Barkalow1468bd42008-02-25 19:24:481760extern void maybe_flush_or_die(FILE *, const char *);
Jeff King9540ce52014-09-10 10:03:521761__attribute__((format (printf, 2, 3)))
1762extern void fprintf_or_die(FILE *, const char *fmt, ...);
Junio C Hamano00b7cbf2015-05-19 17:55:161763
1764#define COPY_READ_ERROR (-2)
1765#define COPY_WRITE_ERROR (-3)
Daniel Barkalow1468bd42008-02-25 19:24:481766extern int copy_fd(int ifd, int ofd);
Clemens Buchacherf7835a22009-09-12 09:03:481767extern int copy_file(const char *dst, const char *src, int mode);
Rene Scharfe7230e6d2006-08-21 18:43:431768extern int copy_file_with_time(const char *dst, const char *src, int mode);
Junio C Hamano00b7cbf2015-05-19 17:55:161769
Christian Couder6ce4e612006-09-02 16:23:481770extern void write_or_die(int fd, const void *buf, size_t count);
Junio C Hamanoad897212005-12-15 06:17:381771extern void fsync_or_die(int fd, const char *);
Jim Meyering2b7ca832009-09-12 08:54:321772
1773extern ssize_t read_in_full(int fd, void *buf, size_t count);
1774extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1775extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1776
1777static inline ssize_t write_str_in_full(int fd, const char *str)
1778{
Linus Torvaldsf67b45f2006-02-28 19:26:211779 return write_in_full(fd, str, strlen(str));
1780}
Junio C Hamano12d6ce12015-08-24 20:03:071781
Jeff King52563d72016-07-08 09:12:221782/**
1783 * Open (and truncate) the file at path, write the contents of buf to it,
1784 * and close it. Dies if any errors are encountered.
1785 */
1786extern void write_file_buf(const char *path, const char *buf, size_t len);
1787
Jeff Kinge04d08a2016-07-08 09:12:421788/**
1789 * Like write_file_buf(), but format the contents into a buffer first.
1790 * Additionally, write_file() will append a newline if one is not already
1791 * present, making it convenient to write text files:
1792 *
1793 * write_file(path, "counter: %d", ctr);
1794 */
1795__attribute__((format (printf, 2, 3)))
Jeff Kingef223182016-07-08 09:09:341796extern void write_file(const char *path, const char *fmt, ...);
Jim Meyering2b7ca832009-09-12 08:54:321797
Linus Torvaldsf67b45f2006-02-28 19:26:211798/* pager.c */
1799extern void setup_pager(void);
Christian Couder872da322008-02-16 05:01:111800extern const char *pager_program;
Jeff King6e9af862007-12-11 06:27:331801extern int pager_in_use(void);
Matthias Lederhoferaa086eb2006-07-29 22:27:431802extern int pager_use_color;
Zbigniew Jędrzejewski-Szmekad6c3732012-02-12 14:12:321803extern int term_columns(void);
Jeff Kingd306f3d2015-02-05 08:14:191804extern int decimal_width(uintmax_t);
Nguyễn Thái Ngọc Duy4914c962012-10-26 15:53:521805extern int check_pager_config(const char *cmd);
Junio C Hamano3e3a4a42016-02-16 22:34:441806extern void prepare_pager_args(struct child_process *, const char *pager);
Linus Torvaldsf67b45f2006-02-28 19:26:211807
Christian Couderee9601e2008-02-16 05:01:411808extern const char *editor_program;
Anselm Kruisd3e7da82010-08-30 13:38:381809extern const char *askpass_program;
Christian Couderdfb068b2008-02-16 05:01:591810extern const char *excludes_file;
Johannes Schindelin4d87b9c2007-07-20 12:06:091811
Junio C Hamano051308f2006-05-04 23:51:441812/* base85 */
Jim Meyeringf9815772007-04-09 22:56:331813int decode_85(char *dst, const char *line, int linelen);
1814void encode_85(char *buf, const unsigned char *data, int bytes);
Junio C Hamano051308f2006-05-04 23:51:441815
Linus Torvalds855419f2006-06-19 17:44:151816/* alloc.c */
Linus Torvalds100c5f32007-04-17 05:11:431817extern void *alloc_blob_node(void);
1818extern void *alloc_tree_node(void);
1819extern void *alloc_commit_node(void);
1820extern void *alloc_tag_node(void);
1821extern void *alloc_object_node(void);
Linus Torvalds855419f2006-06-19 17:44:151822extern void alloc_report(void);
Jeff King94d5a222014-07-13 06:42:081823extern unsigned int alloc_commit_index(void);
Linus Torvalds855419f2006-06-19 17:44:151824
Karsten Blees5991a552014-06-11 07:56:491825/* pkt-line.c */
Jeff Kingbbc30f92011-02-24 14:30:191826void packet_trace_identity(const char *prog);
Christian Couder6ce4e612006-09-02 16:23:481827
Junio C Hamanob6ec1d62007-11-18 09:12:041828/* add */
Alex Riesen7ae02a32008-05-12 17:58:101829/*
1830 * return 0 if success, 1 - if addition of a file failed and
1831 * ADD_FILES_IGNORE_ERRORS was specified in flags
1832 */
Thomas Gummerer610d55a2016-09-14 21:07:471833int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
Junio C Hamanob6ec1d62007-11-18 09:12:041834
Junio C Hamanoaecbf912007-08-31 20:13:421835/* diff.c */
1836extern int diff_auto_refresh_index;
1837
Junio C Hamano68faf682007-02-16 00:32:451838/* match-trees.c */
brian m. carlson82db3d42016-04-17 23:10:381839void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);
1840void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);
Junio C Hamano68faf682007-02-16 00:32:451841
Junio C Hamanoa9cc8572007-11-02 07:24:271842/*
1843 * whitespace rules.
1844 * used by both diff and apply
Johannes Sixtf4b05a42010-11-30 08:29:111845 * last two digits are tab width
Junio C Hamanoa9cc8572007-11-02 07:24:271846 */
Johannes Sixtf4b05a42010-11-30 08:29:111847#define WS_BLANK_AT_EOL 0100
1848#define WS_SPACE_BEFORE_TAB 0200
1849#define WS_INDENT_WITH_NON_TAB 0400
1850#define WS_CR_AT_EOL 01000
1851#define WS_BLANK_AT_EOF 02000
1852#define WS_TAB_IN_INDENT 04000
Junio C Hamanoaeb84b02009-09-06 05:21:171853#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
Johannes Sixtf4b05a42010-11-30 08:29:111854#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1855#define WS_TAB_WIDTH_MASK 077
Junio C Hamanocf1b7862007-12-06 08:14:141856extern unsigned whitespace_rule_cfg;
1857extern unsigned whitespace_rule(const char *);
1858extern unsigned parse_whitespace_rule(const char *);
Junio C Hamano8f8841e2008-06-26 22:35:211859extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1860extern 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:291861extern char *whitespace_error_string(unsigned ws);
Chris Webbd511bd32010-04-02 23:37:231862extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
Junio C Hamano877f23c2008-06-26 22:36:591863extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
Johannes Sixtf4b05a42010-11-30 08:29:111864#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
Junio C Hamanoa9cc8572007-11-02 07:24:271865
Junio C Hamanoee425e42007-11-18 09:13:321866/* ls-files */
Junio C Hamanoee425e42007-11-18 09:13:321867void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1868
Jeff King94351112008-02-24 22:17:141869char *alias_lookup(const char *alias);
Miklos Vajna0989fe92008-06-27 16:21:541870int split_cmdline(char *cmdline, const char ***argv);
Greg Brockmanad9ac6d2010-08-07 05:13:391871/* Takes a negative value returned by split_cmdline */
1872const char *split_cmdline_strerror(int cmdline_errno);
Jeff King94351112008-02-24 22:17:141873
Jeff King46c3cd42016-03-05 22:10:271874/* setup.c */
Nguyễn Thái Ngọc Duye37c1322010-08-06 02:40:351875struct startup_info {
Nguyễn Thái Ngọc Duya60645f2010-08-06 02:46:331876 int have_repository;
Nguyễn Thái Ngọc Duyf07d6a12010-12-01 23:33:221877 const char *prefix;
Nguyễn Thái Ngọc Duye37c1322010-08-06 02:40:351878};
1879extern struct startup_info *startup_info;
1880
Nguyễn Thái Ngọc Duydb699a82012-10-26 15:53:491881/* merge.c */
1882struct commit_list;
1883int try_merge_command(const char *strategy, size_t xopts_nr,
1884 const char **xopts, struct commit_list *common,
1885 const char *head_arg, struct commit_list *remotes);
1886int checkout_fast_forward(const unsigned char *from,
1887 const unsigned char *to,
1888 int overwrite_ignore);
1889
Junio C Hamanocac42b22010-03-06 20:34:411890
Jeff King38f865c2012-03-30 07:52:181891int sane_execvp(const char *file, char *const argv[]);
1892
Michael Haggerty38612532013-06-20 08:37:511893/*
1894 * A struct to encapsulate the concept of whether a file has changed
1895 * since we last checked it. This uses criteria similar to those used
1896 * for the index.
1897 */
1898struct stat_validity {
1899 struct stat_data *sd;
1900};
1901
1902void stat_validity_clear(struct stat_validity *sv);
1903
1904/*
1905 * Returns 1 if the path is a regular file (or a symlink to a regular
1906 * file) and matches the saved stat_validity, 0 otherwise. A missing
1907 * or inaccessible file is considered a match if the struct was just
1908 * initialized, or if the previous update found an inaccessible file.
1909 */
1910int stat_validity_check(struct stat_validity *sv, const char *path);
1911
1912/*
1913 * Update the stat_validity from a file opened at descriptor fd. If
1914 * the file is missing, inaccessible, or not a regular file, then
1915 * future calls to stat_validity_check will match iff one of those
1916 * conditions continues to be true.
1917 */
1918void stat_validity_update(struct stat_validity *sv, int fd);
1919
Nguyễn Thái Ngọc Duy9ef176b2014-02-27 12:56:521920int versioncmp(const char *s1, const char *s2);
Johannes Sixt2024d312015-06-05 19:45:051921void sleep_millisec(int millisec);
Nguyễn Thái Ngọc Duy9ef176b2014-02-27 12:56:521922
David Turnereb338762015-11-10 11:42:381923/*
1924 * Create a directory and (if share is nonzero) adjust its permissions
1925 * according to the shared_repository setting. Only use this for
1926 * directories under $GIT_DIR. Don't use it for working tree
1927 * directories.
1928 */
1929void safe_create_dir(const char *dir, int share);
1930
Linus Torvaldse83c5162005-04-07 22:13:131931#endif /* CACHE_H */