🌐 AI搜索 & 代理 主页
blob: 52b91f5b64146e1b6c7c93aa5054a7aca6303b42 [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"
brian m. carlsonf18f8162017-03-11 22:28:1813#include "hash.h"
Linus Torvaldse83c5162005-04-07 22:13:1314
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
brian m. carlson5028bf62017-03-26 16:01:2369/* The length in byte and in hex digits of the largest possible hash value. */
70#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ
71#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ
72
brian m. carlson5f7817c2015-03-13 23:39:2773struct object_id {
brian m. carlson5028bf62017-03-26 16:01:2374 unsigned char hash[GIT_MAX_RAWSZ];
brian m. carlson5f7817c2015-03-13 23:39:2775};
76
Timo Hirvonen962554c2006-02-26 15:13:4677#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
Edgar Toernigb6829692005-04-30 16:51:0378#define DTYPE(de) ((de)->d_type)
79#else
Junio C Hamano0bdd79a2006-01-20 21:33:2080#undef DT_UNKNOWN
81#undef DT_DIR
82#undef DT_REG
83#undef DT_LNK
Edgar Toernigb6829692005-04-30 16:51:0384#define DT_UNKNOWN 0
85#define DT_DIR 1
86#define DT_REG 2
Junio C Hamanoa15c1c62005-05-13 00:16:0487#define DT_LNK 3
Edgar Toernigb6829692005-04-30 16:51:0388#define DTYPE(de) DT_UNKNOWN
89#endif
90
Martin Koegler40689ae2007-04-22 16:43:5691/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
92#define S_IFINVALID 0030000
93
Linus Torvaldse83c5162005-04-07 22:13:1394/*
Linus Torvalds9eec4792007-04-10 04:14:5895 * A "directory link" is a link to another git directory.
96 *
97 * The value 0160000 is not normally a valid mode, and
98 * also just happens to be S_IFDIR + S_IFLNK
Linus Torvalds9eec4792007-04-10 04:14:5899 */
Martin Waitz302b9282007-05-21 20:08:28100#define S_IFGITLINK 0160000
101#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
Linus Torvalds9eec4792007-04-10 04:14:58102
103/*
Kirill Smelkov72441af2014-04-06 21:46:26104 * Some mode bits are also used internally for computations.
105 *
106 * They *must* not overlap with any valid modes, and they *must* not be emitted
107 * to outside world - i.e. appear on disk or network. In other words, it's just
108 * temporary fields, which we internally use, but they have to stay in-house.
109 *
110 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
111 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
112 */
113
114/* used internally in tree-diff */
115#define S_DIFFTREE_IFXMIN_NEQ 0x80000000
116
117
118/*
Linus Torvalds2386d652005-07-14 01:46:20119 * Intensive research over the course of many years has shown that
120 * port 9418 is totally unused by anything else. Or
121 *
122 * Your search - "port 9418" - did not match any documents.
123 *
124 * as www.google.com puts it.
Linus Torvaldsba8a4972005-09-12 18:23:00125 *
126 * This port has been properly assigned for git use by IANA:
127 * git (Assigned-9418) [I06-050728-0001].
128 *
129 * git 9418/tcp git pack transfer service
130 * git 9418/udp git pack transfer service
131 *
132 * with Linus Torvalds <torvalds@osdl.org> as the point of
133 * contact. September 2005.
134 *
135 * See http://www.iana.org/assignments/port-numbers
Linus Torvalds2386d652005-07-14 01:46:20136 */
137#define DEFAULT_GIT_PORT 9418
138
139/*
Linus Torvaldse83c5162005-04-07 22:13:13140 * Basic data structures for the directory cache
Linus Torvaldse83c5162005-04-07 22:13:13141 */
142
143#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
144struct cache_header {
Thomas Gummerer7800c1e2013-08-18 19:41:51145 uint32_t hdr_signature;
146 uint32_t hdr_version;
147 uint32_t hdr_entries;
Linus Torvaldse83c5162005-04-07 22:13:13148};
149
Junio C Hamano9d227782012-04-04 16:12:43150#define INDEX_FORMAT_LB 2
151#define INDEX_FORMAT_UB 4
152
Linus Torvaldse83c5162005-04-07 22:13:13153/*
154 * The "cache_time" is just the low 32 bits of the
155 * time. It doesn't matter if it overflows - we only
156 * check it for equality in the 32 bits we save.
157 */
158struct cache_time {
Thomas Gummerer7800c1e2013-08-18 19:41:51159 uint32_t sec;
160 uint32_t nsec;
Linus Torvaldse83c5162005-04-07 22:13:13161};
162
Michael Haggertyc21d39d2013-06-20 08:37:50163struct stat_data {
164 struct cache_time sd_ctime;
165 struct cache_time sd_mtime;
166 unsigned int sd_dev;
167 unsigned int sd_ino;
168 unsigned int sd_uid;
169 unsigned int sd_gid;
170 unsigned int sd_size;
171};
172
Linus Torvaldse83c5162005-04-07 22:13:13173struct cache_entry {
Karsten Blees8b013782013-11-14 19:21:58174 struct hashmap_entry ent;
Michael Haggertyc21d39d2013-06-20 08:37:50175 struct stat_data ce_stat_data;
Linus Torvaldsccc4feb2005-04-15 17:44:27176 unsigned int ce_mode;
Linus Torvalds7a51ed62008-01-15 00:03:17177 unsigned int ce_flags;
Thomas Gummererb60e1882012-07-11 09:22:37178 unsigned int ce_namelen;
Nguyễn Thái Ngọc Duy5fc2fc82014-06-13 12:19:36179 unsigned int index; /* for link extension */
brian m. carlson99d1a982016-09-05 20:07:52180 struct object_id oid;
Junio C Hamano8f1d2e62006-01-07 09:33:54181 char name[FLEX_ARRAY]; /* more */
Linus Torvaldse83c5162005-04-07 22:13:13182};
183
Linus Torvalds95fd5bf2005-04-16 05:51:44184#define CE_STAGEMASK (0x3000)
Junio C Hamano16ce2e4c2008-08-17 06:02:08185#define CE_EXTENDED (0x4000)
Junio C Hamano5f730762006-02-09 05:15:24186#define CE_VALID (0x8000)
Junio C Hamanoaee46192005-04-16 15:33:23187#define CE_STAGESHIFT 12
Linus Torvalds95fd5bf2005-04-16 05:51:44188
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01189/*
Nguyễn Thái Ngọc Duyce51bf02014-06-13 12:19:25190 * Range 0xFFFF0FFF in ce_flags is divided into
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01191 * two parts: in-memory flags and on-disk ones.
192 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
193 * if you want to save a new flag, add it in
194 * CE_EXTENDED_FLAGS
195 *
196 * In-memory only flags
197 */
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16198#define CE_UPDATE (1 << 16)
199#define CE_REMOVE (1 << 17)
200#define CE_UPTODATE (1 << 18)
201#define CE_ADDED (1 << 19)
Linus Torvaldsa22c6372008-02-23 04:37:40202
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16203#define CE_HASHED (1 << 20)
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16204#define CE_WT_REMOVE (1 << 22) /* remove in work directory */
205#define CE_CONFLICTED (1 << 23)
Linus Torvalds7a51ed62008-01-15 00:03:17206
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16207#define CE_UNPACKED (1 << 24)
Nguyễn Thái Ngọc Duy2431afb2010-11-27 06:24:04208#define CE_NEW_SKIP_WORKTREE (1 << 25)
Junio C Hamanoda165f42010-01-07 22:59:54209
Nguyễn Thái Ngọc Duye721c152013-03-27 05:58:21210/* used to temporarily mark paths matched by pathspecs */
211#define CE_MATCHED (1 << 26)
212
Nguyễn Thái Ngọc Duy078a58e2014-06-13 12:19:39213#define CE_UPDATE_IN_BASE (1 << 27)
Nguyễn Thái Ngọc Duyb3c96fb2014-06-13 12:19:43214#define CE_STRIP_NAME (1 << 28)
Nguyễn Thái Ngọc Duy078a58e2014-06-13 12:19:39215
Linus Torvaldsd070e3a2008-02-23 04:39:21216/*
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01217 * Extended on-disk flags
218 */
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16219#define CE_INTENT_TO_ADD (1 << 29)
220#define CE_SKIP_WORKTREE (1 << 30)
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01221/* CE_EXTENDED2 is for future extension */
Jeff King9a93c662015-12-29 06:35:46222#define CE_EXTENDED2 (1U << 31)
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01223
Nguyễn Thái Ngọc Duy44a36912009-08-20 13:46:57224#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01225
226/*
227 * Safeguard to avoid saving wrong flags:
228 * - CE_EXTENDED2 won't get saved until its semantic is known
229 * - Bits in 0x0000FFFF have been saved in ce_flags already
230 * - Bits in 0x003F0000 are currently in-memory flags
231 */
232#if CE_EXTENDED_FLAGS & 0x803FFFFF
233#error "CE_EXTENDED_FLAGS out of range"
234#endif
235
Junio C Hamano3e3a4a42016-02-16 22:34:44236/* Forward structure decls */
Nguyễn Thái Ngọc Duy64acde92013-07-14 08:35:25237struct pathspec;
Junio C Hamano3e3a4a42016-02-16 22:34:44238struct child_process;
Nguyễn Thái Ngọc Duy64acde92013-07-14 08:35:25239
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01240/*
Linus Torvaldseb7a2f12008-02-23 04:41:17241 * Copy the sha1 and stat state of a cache entry from one to
242 * another. But we never change the name, or the hash state!
243 */
René Scharfe20d142b2013-06-02 15:46:51244static inline void copy_cache_entry(struct cache_entry *dst,
245 const struct cache_entry *src)
Linus Torvaldseb7a2f12008-02-23 04:41:17246{
Karsten Blees419a5972013-11-14 19:22:27247 unsigned int state = dst->ce_flags & CE_HASHED;
Linus Torvaldseb7a2f12008-02-23 04:41:17248
249 /* Don't copy hash chain and name */
Karsten Blees8b013782013-11-14 19:21:58250 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
251 offsetof(struct cache_entry, name) -
252 offsetof(struct cache_entry, ce_stat_data));
Linus Torvaldseb7a2f12008-02-23 04:41:17253
254 /* Restore the hash state */
Karsten Blees419a5972013-11-14 19:22:27255 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
Linus Torvaldseb7a2f12008-02-23 04:41:17256}
257
Thomas Gummererb60e1882012-07-11 09:22:37258static inline unsigned create_ce_flags(unsigned stage)
Junio C Hamano7fec10b2008-01-19 07:42:00259{
Thomas Gummererb60e1882012-07-11 09:22:37260 return (stage << CE_STAGESHIFT);
Junio C Hamano7fec10b2008-01-19 07:42:00261}
262
Thomas Gummererb60e1882012-07-11 09:22:37263#define ce_namelen(ce) ((ce)->ce_namelen)
Junio C Hamanoaee46192005-04-16 15:33:23264#define ce_size(ce) cache_entry_size(ce_namelen(ce))
Linus Torvalds7a51ed62008-01-15 00:03:17265#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
Junio C Hamanoeadb5832008-01-19 07:45:24266#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
Nguyễn Thái Ngọc Duy44a36912009-08-20 13:46:57267#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
Junio C Hamanoeadb5832008-01-19 07:45:24268#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
Nguyễn Thái Ngọc Duy895ff3b2015-08-22 01:08:05269#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
Junio C Hamanoaee46192005-04-16 15:33:23270
Linus Torvaldse4479472005-04-17 05:26:31271#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
Kay Sievers8ae0a8c2005-05-05 12:38:25272static inline unsigned int create_ce_mode(unsigned int mode)
273{
Kay Sievers8ae0a8c2005-05-05 12:38:25274 if (S_ISLNK(mode))
Linus Torvalds7a51ed62008-01-15 00:03:17275 return S_IFLNK;
Martin Waitz302b9282007-05-21 20:08:28276 if (S_ISDIR(mode) || S_ISGITLINK(mode))
Linus Torvalds7a51ed62008-01-15 00:03:17277 return S_IFGITLINK;
278 return S_IFREG | ce_permissions(mode);
Kay Sievers8ae0a8c2005-05-05 12:38:25279}
René Scharfe20d142b2013-06-02 15:46:51280static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
281 unsigned int mode)
Junio C Hamano185c9752007-02-17 06:43:48282{
Johannes Sixt78a8d642007-03-02 21:11:30283 extern int trust_executable_bit, has_symlinks;
284 if (!has_symlinks && S_ISREG(mode) &&
Linus Torvalds7a51ed62008-01-15 00:03:17285 ce && S_ISLNK(ce->ce_mode))
Johannes Sixt78a8d642007-03-02 21:11:30286 return ce->ce_mode;
Junio C Hamano185c9752007-02-17 06:43:48287 if (!trust_executable_bit && S_ISREG(mode)) {
Linus Torvalds7a51ed62008-01-15 00:03:17288 if (ce && S_ISREG(ce->ce_mode))
Junio C Hamano185c9752007-02-17 06:43:48289 return ce->ce_mode;
290 return create_ce_mode(0666);
291 }
292 return create_ce_mode(mode);
293}
Junio C Hamanod6b8fc32008-01-31 09:17:48294static inline int ce_to_dtype(const struct cache_entry *ce)
295{
296 unsigned ce_mode = ntohl(ce->ce_mode);
297 if (S_ISREG(ce_mode))
298 return DT_REG;
299 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
300 return DT_DIR;
301 else if (S_ISLNK(ce_mode))
302 return DT_LNK;
303 else
304 return DT_UNKNOWN;
305}
René Scharfeb90d9b82010-10-04 10:53:11306static inline unsigned int canon_mode(unsigned int mode)
307{
308 if (S_ISREG(mode))
309 return S_IFREG | ce_permissions(mode);
310 if (S_ISLNK(mode))
311 return S_IFLNK;
312 if (S_ISDIR(mode))
313 return S_IFDIR;
314 return S_IFGITLINK;
315}
Linus Torvaldse4479472005-04-17 05:26:31316
René Scharfeee7825b2011-10-25 18:00:04317#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
Linus Torvaldsf5cabd12005-04-16 04:45:38318
Nguyễn Thái Ngọc Duye636a7b2014-06-13 12:19:27319#define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
320#define CE_ENTRY_CHANGED (1 << 1)
321#define CE_ENTRY_REMOVED (1 << 2)
322#define CE_ENTRY_ADDED (1 << 3)
Nguyễn Thái Ngọc Duy6c306a32014-06-13 12:19:29323#define RESOLVE_UNDO_CHANGED (1 << 4)
Nguyễn Thái Ngọc Duya5400ef2014-06-13 12:19:31324#define CACHE_TREE_CHANGED (1 << 5)
Nguyễn Thái Ngọc Duyc18b80a2014-06-13 12:19:44325#define SPLIT_INDEX_ORDERED (1 << 6)
Nguyễn Thái Ngọc Duy1bbb3db2015-03-08 10:12:39326#define UNTRACKED_CHANGED (1 << 7)
Nguyễn Thái Ngọc Duye636a7b2014-06-13 12:19:27327
Nguyễn Thái Ngọc Duy5fc2fc82014-06-13 12:19:36328struct split_index;
Nguyễn Thái Ngọc Duy83c094a2015-03-08 10:12:33329struct untracked_cache;
330
Junio C Hamano228e94f2007-04-02 01:14:06331struct index_state {
332 struct cache_entry **cache;
Junio C Hamano9d227782012-04-04 16:12:43333 unsigned int version;
Junio C Hamano228e94f2007-04-02 01:14:06334 unsigned int cache_nr, cache_alloc, cache_changed;
Junio C Hamanocfc57892009-12-25 08:30:51335 struct string_list *resolve_undo;
Junio C Hamano228e94f2007-04-02 01:14:06336 struct cache_tree *cache_tree;
Nguyễn Thái Ngọc Duy5fc2fc82014-06-13 12:19:36337 struct split_index *split_index;
Kjetil Barvikfba2f382009-02-19 20:08:29338 struct cache_time timestamp;
Junio C Hamano913e0e92008-08-23 19:57:30339 unsigned name_hash_initialized : 1,
340 initialized : 1;
Karsten Blees8b013782013-11-14 19:21:58341 struct hashmap name_hash;
Karsten Bleese05881a2013-11-14 19:20:58342 struct hashmap dir_hash;
Yiannis Marangos426ddee2014-04-10 18:31:21343 unsigned char sha1[20];
Nguyễn Thái Ngọc Duy83c094a2015-03-08 10:12:33344 struct untracked_cache *untracked;
Junio C Hamano228e94f2007-04-02 01:14:06345};
346
347extern struct index_state the_index;
348
Linus Torvalds96872bc2008-03-21 20:16:24349/* Name hashing */
Jeff Hostetlerea194892017-03-23 13:47:04350extern int test_lazy_init_name_hash(struct index_state *istate, int try_threaded);
Linus Torvalds96872bc2008-03-21 20:16:24351extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
Karsten Blees20926782013-02-27 23:57:48352extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
353extern void free_name_hash(struct index_state *istate);
Linus Torvalds96872bc2008-03-21 20:16:24354
355
Junio C Hamano4aab5b42007-04-02 06:26:07356#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
Junio C Hamano228e94f2007-04-02 01:14:06357#define active_cache (the_index.cache)
358#define active_nr (the_index.cache_nr)
359#define active_alloc (the_index.cache_alloc)
360#define active_cache_changed (the_index.cache_changed)
361#define active_cache_tree (the_index.cache_tree)
Linus Torvaldse83c5162005-04-07 22:13:13362
Junio C Hamano4aab5b42007-04-02 06:26:07363#define read_cache() read_index(&the_index)
364#define read_cache_from(path) read_index_from(&the_index, (path))
Linus Torvalds671c9b72008-11-14 00:36:30365#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
Junio C Hamanofa7b3c22008-11-12 19:52:35366#define is_cache_unborn() is_index_unborn(&the_index)
Miklos Vajnae46bbcf2008-06-27 16:21:58367#define read_cache_unmerged() read_index_unmerged(&the_index)
Junio C Hamano4aab5b42007-04-02 06:26:07368#define discard_cache() discard_index(&the_index)
Daniel Barkalow94a57282008-02-07 16:40:13369#define unmerged_cache() unmerged_index(&the_index)
Junio C Hamano4aab5b42007-04-02 06:26:07370#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
371#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
Petr Baudis81dc2302008-07-21 00:25:56372#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
Junio C Hamano4aab5b42007-04-02 06:26:07373#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
374#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
Thomas Gummerer610d55a2016-09-14 21:07:47375#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
376#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
Thomas Gummererd9d70962016-09-14 21:07:46377#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
Matthieu Moy3deffc52009-08-21 08:57:59378#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
Junio C Hamano4bd5b7d2007-11-10 08:15:03379#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
380#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
Eric Sunshinedb5360f2013-09-17 07:06:14381#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
382#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
Jeff King98fa4732008-10-16 15:07:26383#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
Junio C Hamanocfc57892009-12-25 08:30:51384#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
Junio C Hamano8aa38562009-12-25 21:40:02385#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
Junio C Hamano4421a822009-12-25 19:57:11386#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
Lukas Fleischerff366822013-04-13 13:28:31387#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
Junio C Hamano4aab5b42007-04-02 06:26:07388#endif
Linus Torvaldse83c5162005-04-07 22:13:13389
Junio C Hamanoedaec3f2007-02-28 19:45:56390enum object_type {
391 OBJ_BAD = -1,
392 OBJ_NONE = 0,
393 OBJ_COMMIT = 1,
394 OBJ_TREE = 2,
395 OBJ_BLOB = 3,
396 OBJ_TAG = 4,
397 /* 5 for future expansion */
398 OBJ_OFS_DELTA = 6,
399 OBJ_REF_DELTA = 7,
Martin Koegler355885d2008-02-25 21:46:04400 OBJ_ANY,
Gary V. Vaughan4b055482010-05-14 09:31:35401 OBJ_MAX
Junio C Hamanoedaec3f2007-02-28 19:45:56402};
403
Junio C Hamanob45563a2007-12-01 06:22:38404static inline enum object_type object_type(unsigned int mode)
405{
406 return S_ISDIR(mode) ? OBJ_TREE :
407 S_ISGITLINK(mode) ? OBJ_COMMIT :
408 OBJ_BLOB;
409}
410
Jeff King2163e5d2013-03-08 09:29:08411/* Double-check local_repo_env below if you add to this list. */
Junio C Hamano8ac069a2005-05-10 05:57:58412#define GIT_DIR_ENVIRONMENT "GIT_DIR"
Nguy��n Thái Ngọc Duyc7b3a3d2014-11-30 08:24:36413#define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
Josh Tripletta1bea2c2011-07-05 17:54:44414#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
Matthias Lederhofer892c41b2007-06-06 07:10:42415#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
Jeff Kinga6f7f9a2013-03-08 09:30:25416#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
Brandon Williams74866d72016-10-07 18:18:48417#define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
Brandon Williamsb58a68c2017-03-17 17:22:54418#define GIT_TOPLEVEL_PREFIX_ENVIRONMENT "GIT_INTERNAL_TOPLEVEL_PREFIX"
Junio C Hamano8ac069a2005-05-10 05:57:58419#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
Junio C Hamanod19938a2005-05-10 00:57:56420#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
Linus Torvaldsbb233d62005-04-21 17:55:18421#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
Junio C Hamano5da5c8f2005-07-30 07:58:28422#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
Nguyễn Thái Ngọc Duy069c0532013-12-05 13:02:45423#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
Junio C Hamanod4ebc362006-12-19 09:28:15424#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
425#define CONFIG_ENVIRONMENT "GIT_CONFIG"
Jeff King2b64fc82010-08-23 19:16:00426#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
Junio C Hamanod4ebc362006-12-19 09:28:15427#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
David Reiss0454dd92008-05-20 06:49:26428#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
Christian Couder6476b382009-11-18 06:50:58429#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
Mike Hommey58d121b2015-06-11 21:34:59430#define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
Junio C Hamanod0bfd022007-04-12 08:07:32431#define GITATTRIBUTES_FILE ".gitattributes"
432#define INFOATTRIBUTES_FILE "info/attributes"
Junio C Hamanof48fd682007-04-14 15:54:37433#define ATTRIBUTE_MACRO_PREFIX "[attr]"
Johannes Schindelina97a7462009-10-09 10:21:57434#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
435#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
Thomas Rast894a9d32010-03-12 17:04:26436#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
Thomas Rast6956f852010-03-12 17:04:32437#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
438#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
Jeff King823ab402012-12-19 22:37:30439#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
Nguyễn Thái Ngọc Duybd30c2e2013-07-14 08:36:08440#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
441#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
Nguyễn Thái Ngọc Duy93d93532013-07-14 08:36:09442#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
Jeff Kinge34c2e02016-10-03 20:49:18443#define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
Linus Torvaldsbb233d62005-04-21 17:55:18444
Giuseppe Bilotta48a7c1c2010-02-24 23:34:14445/*
Jeff King2cd83d12013-03-08 09:32:22446 * This environment variable is expected to contain a boolean indicating
447 * whether we should or should not treat:
448 *
449 * GIT_DIR=foo.git git ...
450 *
451 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
452 * of this, but we use it internally to communicate to sub-processes that we
453 * are in a bare repo. If not set, defaults to true.
Giuseppe Bilotta48a7c1c2010-02-24 23:34:14454 */
Jeff King2cd83d12013-03-08 09:32:22455#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
456
457/*
Jeff King2163e5d2013-03-08 09:29:08458 * Repository-local GIT_* environment variables; these will be cleared
459 * when git spawns a sub-process that runs inside another repository.
460 * The array is NULL-terminated, which makes it easy to pass in the "env"
461 * parameter of a run-command invocation, or to do a simple walk.
Giuseppe Bilotta48a7c1c2010-02-24 23:34:14462 */
Jeff King2163e5d2013-03-08 09:29:08463extern const char * const local_repo_env[];
Giuseppe Bilotta48a7c1c2010-02-24 23:34:14464
Jeff Kingb9605bc2016-09-13 03:24:15465/*
466 * Returns true iff we have a configured git repository (either via
467 * setup_git_directory, or in the environment via $GIT_DIR).
468 */
469int have_git_dir(void);
470
Junio C Hamano7d1864c2007-01-07 10:00:28471extern int is_bare_repository_cfg;
472extern int is_bare_repository(void);
Johannes Schindelin68025632007-01-20 02:09:34473extern int is_inside_git_dir(void);
Johannes Schindeline90fdc32007-08-01 00:30:14474extern char *git_work_tree_cfg;
Matthias Lederhofer892c41b2007-06-06 07:10:42475extern int is_inside_work_tree(void);
Pierre Habouzitc5fba162006-08-23 10:39:11476extern const char *get_git_dir(void);
Nguyễn Thái Ngọc Duyc7b3a3d2014-11-30 08:24:36477extern const char *get_git_common_dir(void);
Junio C Hamano8ac069a2005-05-10 05:57:58478extern char *get_object_directory(void);
Junio C Hamano8ac069a2005-05-10 05:57:58479extern char *get_index_file(void);
Junio C Hamano5da5c8f2005-07-30 07:58:28480extern char *get_graft_file(void);
Johannes Schindelind7ac12b2007-08-01 00:29:38481extern int set_git_dir(const char *path);
Max Kirillov11f9dd72015-09-13 22:17:42482extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
Nguyễn Thái Ngọc Duy31e26eb2014-11-30 08:24:44483extern int get_common_dir(struct strbuf *sb, const char *gitdir);
Josh Tripletta1bea2c2011-07-05 17:54:44484extern const char *get_git_namespace(void);
485extern const char *strip_namespace(const char *namespaced_ref);
Brandon Williams74866d72016-10-07 18:18:48486extern const char *get_super_prefix(void);
Johannes Schindeline90fdc32007-08-01 00:30:14487extern const char *get_git_work_tree(void);
Erik Elfstr��ma93beda2015-06-09 18:24:35488
Jeff Kingffd036b2016-01-22 22:27:33489/*
490 * Return true if the given path is a git directory; note that this _just_
491 * looks at the directory itself. If you want to know whether "foo/.git"
492 * is a repository, you must feed that path, not just "foo".
493 */
494extern int is_git_directory(const char *path);
495
496/*
497 * Return 1 if the given path is the root of a git repository or
498 * submodule, else 0. Will not return 1 for bare repositories with the
499 * exception of creating a bare repository in "foo/.git" and calling
500 * is_git_repository("foo").
501 *
502 * If we run into read errors, we err on the side of saying "yes, it is",
503 * as we usually consider sub-repos precious, and would prefer to err on the
504 * side of not disrupting or deleting them.
505 */
506extern int is_nonbare_repository_dir(struct strbuf *path);
507
Erik Elfströma93beda2015-06-09 18:24:35508#define READ_GITFILE_ERR_STAT_FAILED 1
509#define READ_GITFILE_ERR_NOT_A_FILE 2
510#define READ_GITFILE_ERR_OPEN_FAILED 3
511#define READ_GITFILE_ERR_READ_FAILED 4
512#define READ_GITFILE_ERR_INVALID_FORMAT 5
513#define READ_GITFILE_ERR_NO_PATH 6
514#define READ_GITFILE_ERR_NOT_A_REPO 7
Erik Elfström921bdd92015-06-15 19:39:52515#define READ_GITFILE_ERR_TOO_LARGE 8
Stefan Beller5f294332017-01-24 23:56:50516extern void read_gitfile_error_die(int error_code, const char *path, const char *dir);
Erik Elfströma93beda2015-06-09 18:24:35517extern const char *read_gitfile_gently(const char *path, int *return_error_code);
518#define read_gitfile(path) read_gitfile_gently((path), NULL)
Stefan Beller40d96322017-01-24 23:56:49519extern const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
520#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
521
Daniel Barkalow19757d82008-04-27 17:39:21522extern void set_git_work_tree(const char *tree);
Junio C Hamano8ac069a2005-05-10 05:57:58523
524#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
Linus Torvaldsbb233d62005-04-21 17:55:18525
Mike Hommey59f0f2f2007-11-03 11:23:11526extern void setup_work_tree(void);
Johannes Schindelin16ac8b82017-03-13 20:10:45527/*
528 * Find GIT_DIR of the repository that contains the current working directory,
529 * without changing the working directory or other global state. The result is
530 * appended to gitdir. The return value is either NULL if no repository was
531 * found, or pointing to the path inside gitdir's buffer.
532 */
533extern const char *discover_git_directory(struct strbuf *gitdir);
Junio C Hamano4ca06602005-11-26 07:14:15534extern const char *setup_git_directory_gently(int *);
Linus Torvaldsd288a702005-08-17 01:06:34535extern const char *setup_git_directory(void);
Nguyễn Thái Ngọc Duyedc54fb2010-11-11 14:08:03536extern char *prefix_path(const char *prefix, int len, const char *path);
Nguyễn Thái Ngọc Duy645a29c2013-07-14 08:36:03537extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
Jeff King59801972017-03-21 01:21:27538
539/*
540 * Concatenate "prefix" (if len is non-zero) and "path", with no
541 * connecting characters (so "prefix" should end with a "/").
542 * Unlike prefix_path, this should be used if the named file does
543 * not have to interact with index entry; i.e. name of a random file
544 * on the filesystem.
545 *
Jeff Kinge4da43b2017-03-21 01:28:49546 * The return value is always a newly allocated string (even if the
547 * prefix was empty).
Jeff King59801972017-03-21 01:21:27548 */
Jeff Kinge4da43b2017-03-21 01:28:49549extern char *prefix_filename(const char *prefix, const char *path);
Jeff King59801972017-03-21 01:21:27550
Junio C Hamanoc6e8c802009-10-18 07:27:24551extern int check_filename(const char *prefix, const char *name);
Matthieu Moy023e37c2012-06-18 18:18:21552extern void verify_filename(const char *prefix,
553 const char *name,
554 int diagnose_misspelt_rev);
Junio C Hamanoea92f412006-04-26 22:09:27555extern void verify_non_filename(const char *prefix, const char *name);
Jeff King546e0fd2012-06-21 18:09:50556extern int path_inside_repo(const char *prefix, const char *path);
Linus Torvaldsd288a702005-08-17 01:06:34557
Daniel Barkalowf225aeb2008-04-27 17:39:27558#define INIT_DB_QUIET 0x0001
Nguyễn Thái Ngọc Duy33158702016-09-25 03:14:37559#define INIT_DB_EXIST_OK 0x0002
Daniel Barkalowf225aeb2008-04-27 17:39:27560
Nguyễn Thái Ngọc Duy33158702016-09-25 03:14:37561extern int init_db(const char *git_dir, const char *real_git_dir,
562 const char *template_dir, unsigned int flags);
Daniel Barkalowf225aeb2008-04-27 17:39:27563
Thomas Rast1d999dd2013-07-16 09:27:36564extern void sanitize_stdfds(void);
Nguyễn Thái Ngọc Duyde0957c2014-02-08 07:08:51565extern int daemonize(void);
Thomas Rast1d999dd2013-07-16 09:27:36566
Linus Torvaldse83c5162005-04-07 22:13:13567#define alloc_nr(x) (((x)+16)*3/2)
568
Jeff King6815e562007-06-11 13:39:44569/*
570 * Realloc the buffer pointed at by variable 'x' so that it can hold
571 * at least 'nr' entries; the number of entries currently allocated
572 * is 'alloc', using the standard growing factor alloc_nr() macro.
573 *
Jonathan Nieder01f6fd42010-10-08 16:46:59574 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
Jeff King6815e562007-06-11 13:39:44575 */
576#define ALLOC_GROW(x, nr, alloc) \
577 do { \
Jeff Kingc927e6c2007-06-16 22:37:39578 if ((nr) > alloc) { \
Junio C Hamano4234a762007-06-12 05:10:55579 if (alloc_nr(alloc) < (nr)) \
580 alloc = (nr); \
581 else \
582 alloc = alloc_nr(alloc); \
René Scharfe2756ca42014-09-16 18:56:57583 REALLOC_ARRAY(x, alloc); \
Jeff King6815e562007-06-11 13:39:44584 } \
Jonathan Nieder98746062010-08-12 22:11:15585 } while (0)
Jeff King6815e562007-06-11 13:39:44586
Linus Torvalds734aab72005-04-09 16:48:20587/* Initialize and use the cache information */
Nguyễn Thái Ngọc Duy03b86642014-06-13 12:19:23588struct lock_file;
Junio C Hamano4aab5b42007-04-02 06:26:07589extern int read_index(struct index_state *);
Nguyễn Thái Ngọc Duy5ab2a2d2013-07-14 08:35:49590extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
Nguyễn Thái Ngọc Duy3e52f702014-06-13 12:19:51591extern int do_read_index(struct index_state *istate, const char *path,
592 int must_exist); /* for testting only! */
Junio C Hamano4aab5b42007-04-02 06:26:07593extern int read_index_from(struct index_state *, const char *path);
Junio C Hamanofa7b3c22008-11-12 19:52:35594extern int is_index_unborn(struct index_state *);
Miklos Vajnae46bbcf2008-06-27 16:21:58595extern int read_index_unmerged(struct index_state *);
Nguyễn Thái Ngọc Duy03b86642014-06-13 12:19:23596#define COMMIT_LOCK (1 << 0)
597#define CLOSE_LOCK (1 << 1)
598extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
Junio C Hamano4aab5b42007-04-02 06:26:07599extern int discard_index(struct index_state *);
Linus Torvaldsd1f128b2008-03-06 20:46:09600extern int unmerged_index(const struct index_state *);
Linus Torvalds8dcf39c2006-05-18 19:07:31601extern int verify_path(const char *path);
Jeff Hostetlera6db3fb2017-04-14 19:12:28602extern int strcmp_offset(const char *s1, const char *s2, size_t *first_change);
David Turner41284eb2015-10-21 17:54:11603extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
604extern void adjust_dirname_case(struct index_state *istate, char *name);
Eric Sunshinedb5360f2013-09-17 07:06:14605extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
Stefan Beller12733e92017-01-19 03:18:51606
607/*
608 * Searches for an entry defined by name and namelen in the given index.
609 * If the return value is positive (including 0) it is the position of an
610 * exact match. If the return value is negative, the negated value minus 1
611 * is the position where the entry would be inserted.
612 * Example: The current index consists of these files and its stages:
613 *
614 * b#0, d#0, f#1, f#3
615 *
616 * index_name_pos(&index, "a", 1) -> -1
617 * index_name_pos(&index, "b", 1) -> 0
618 * index_name_pos(&index, "c", 1) -> -2
619 * index_name_pos(&index, "d", 1) -> 1
620 * index_name_pos(&index, "e", 1) -> -3
621 * index_name_pos(&index, "f", 1) -> -3
622 * index_name_pos(&index, "g", 1) -> -5
623 */
Linus Torvaldsd1f128b2008-03-06 20:46:09624extern int index_name_pos(const struct index_state *, const char *name, int namelen);
Stefan Beller12733e92017-01-19 03:18:51625
Junio C Hamano192268c2005-05-08 04:55:21626#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
627#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
Junio C Hamanob1557252005-06-25 09:25:29628#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
Junio C Hamanoaf3785d2007-08-09 20:42:50629#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
Junio C Hamano39425812008-08-21 08:44:53630#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
Nguyễn Thái Ngọc Duyce7c6142014-06-13 12:19:42631#define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
Junio C Hamano4aab5b42007-04-02 06:26:07632extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
Petr Baudis81dc2302008-07-21 00:25:56633extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
Stefan Beller3bd72ad2017-01-19 03:18:52634
635/* Remove entry, return true if there are more entries to go. */
Junio C Hamano4aab5b42007-04-02 06:26:07636extern int remove_index_entry_at(struct index_state *, int pos);
Stefan Beller3bd72ad2017-01-19 03:18:52637
Kjetil Barvik36419c82009-02-18 22:18:03638extern void remove_marked_cache_entries(struct index_state *istate);
Junio C Hamano4aab5b42007-04-02 06:26:07639extern int remove_file_from_index(struct index_state *, const char *path);
Junio C Hamano38ed1d82008-05-21 19:04:34640#define ADD_CACHE_VERBOSE 1
641#define ADD_CACHE_PRETEND 2
Junio C Hamano01665922008-05-25 21:03:50642#define ADD_CACHE_IGNORE_ERRORS 4
Junio C Hamano041aee32008-07-21 08:24:17643#define ADD_CACHE_IGNORE_REMOVAL 8
Junio C Hamano39425812008-08-21 08:44:53644#define ADD_CACHE_INTENT 16
Stefan Beller20cf41d2017-01-19 03:18:53645/*
646 * These two are used to add the contents of the file at path
647 * to the index, marking the working tree up-to-date by storing
648 * the cached stat info in the resulting cache entry. A caller
649 * that has already run lstat(2) on the path can call
650 * add_to_index(), and all others can call add_file_to_index();
651 * the latter will do necessary lstat(2) internally before
652 * calling the former.
653 */
Thomas Gummerer610d55a2016-09-14 21:07:47654extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
655extern int add_file_to_index(struct index_state *, const char *path, int flags);
Stefan Beller20cf41d2017-01-19 03:18:53656
Brad King25762722014-01-27 14:45:08657extern 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:46658extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
Nguyễn Thái Ngọc Duy9c5e6c82013-07-09 15:29:00659extern 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:09660extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
Jeff King98fa4732008-10-16 15:07:26661extern int index_name_is_other(const struct index_state *, const char *, int);
Brandon Williams87542502017-01-10 20:06:10662extern void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *);
Junio C Hamano4bd5b7d2007-11-10 08:15:03663
664/* do stat comparison even if CE_VALID is true */
665#define CE_MATCH_IGNORE_VALID 01
666/* do not check the contents but report dirty on racily-clean entries */
Nguyễn Thái Ngọc Duy56cac482009-12-14 11:43:58667#define CE_MATCH_RACY_IS_DIRTY 02
668/* do stat comparison even if CE_SKIP_WORKTREE is true */
669#define CE_MATCH_IGNORE_SKIP_WORKTREE 04
Brad King2e2e7ec2014-01-27 14:45:07670/* ignore non-existent files during stat update */
671#define CE_MATCH_IGNORE_MISSING 0x08
Brad King25762722014-01-27 14:45:08672/* enable stat refresh */
673#define CE_MATCH_REFRESH 0x10
René Scharfe21a6b9f2013-06-02 15:46:52674extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
675extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
Junio C Hamano4bd5b7d2007-11-10 08:15:03676
Junio C Hamanoc4ce46f2011-05-08 08:47:33677#define HASH_WRITE_OBJECT 1
678#define HASH_FORMAT_CHECK 2
679extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
680extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
Michael Haggertyc21d39d2013-06-20 08:37:50681
682/*
683 * Record to sd the data from st that we use to check whether a file
684 * might have changed.
685 */
686extern void fill_stat_data(struct stat_data *sd, struct stat *st);
687
688/*
689 * Return 0 if st is consistent with a file not having been changed
690 * since sd was filled. If there are differences, return a
691 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
692 * INODE_CHANGED, and DATA_CHANGED.
693 */
694extern int match_stat_data(const struct stat_data *sd, struct stat *st);
Nguyễn Thái Ngọc Duyed4efab2015-03-08 10:12:37695extern int match_stat_data_racy(const struct index_state *istate,
696 const struct stat_data *sd, struct stat *st);
Michael Haggertyc21d39d2013-06-20 08:37:50697
Junio C Hamano415e96c2005-05-15 21:23:12698extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
699
Linus Torvalds405e5b22006-05-19 16:56:35700#define REFRESH_REALLY 0x0001 /* ignore_valid */
701#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
702#define REFRESH_QUIET 0x0004 /* be quiet about it */
703#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
Junio C Hamano3f1b7b62008-07-20 06:25:00704#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
Matthieu Moy43673fd2009-08-21 08:57:58705#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
Nguyễn Thái Ngọc Duy9b2d6142013-07-14 08:35:54706extern 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:15707extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int);
Linus Torvalds405e5b22006-05-19 16:56:35708
Junio C Hamanoccdc4ec2011-03-21 17:16:10709extern void update_index_if_able(struct index_state *, struct lock_file *);
Junio C Hamano30ca07a2007-04-01 06:09:02710
711extern int hold_locked_index(struct lock_file *, int);
Junio C Hamano5e7f56a2007-04-01 06:27:41712extern void set_alternate_index_output(const char *);
Michael Haggerty697cc8e2014-10-01 10:28:42713
Jeff Hostetlera33fc722017-04-14 20:32:21714extern int verify_index_checksum;
715
Junio C Hamano2ae1c532006-02-27 22:47:45716/* Environment bits from configuration mechanism */
Linus Torvalds17712992005-10-10 23:31:08717extern int trust_executable_bit;
Alex Riesen1ce47902008-07-28 06:31:28718extern int trust_ctime;
Robin Rosenbergc08e4d52013-01-22 07:49:22719extern int check_stat;
Junio C Hamano9378c162007-06-24 22:11:24720extern int quote_path_fully;
Johannes Sixt78a8d642007-03-02 21:11:30721extern int has_symlinks;
Linus Torvaldsdce96482010-10-28 18:28:04722extern int minimum_abbrev, default_abbrev;
Linus Torvalds0a9b88b2008-03-21 23:52:46723extern int ignore_case;
Junio C Hamano5f730762006-02-09 05:15:24724extern int assume_unchanged;
Junio C Hamano9f0bb902006-05-02 07:40:24725extern int prefer_symlink_refs;
Junio C Hamano2f8acdb2006-03-21 02:45:47726extern int warn_ambiguous_refs;
Jeff King25fba782013-07-12 06:20:05727extern int warn_on_object_refname_ambiguity;
Junio C Hamano2ae1c532006-02-27 22:47:45728extern const char *apply_default_whitespace;
Giuseppe Bilotta86c91f92009-08-04 11:16:49729extern const char *apply_default_ignorewhitespace;
Junio C Hamano64589a02011-10-06 18:22:24730extern const char *git_attributes_file;
Ævar Arnfjörð Bjarmason867ad082016-05-04 22:58:12731extern const char *git_hooks_path;
Joachim B Haga12f6c302006-07-03 20:11:47732extern int zlib_compression_level;
Dana How960ccca2007-05-09 20:56:50733extern int core_compression_level;
Junio C Hamano8de7eeb2016-11-16 01:42:40734extern int pack_compression_level;
Shawn O. Pearce60bb8b12006-12-23 07:34:28735extern size_t packed_git_window_size;
Shawn O. Pearce77ccc5b2006-12-23 07:33:35736extern size_t packed_git_limit;
Shawn O. Pearce18bdec12007-03-19 05:14:37737extern size_t delta_base_cache_limit;
Junio C Hamano15366282011-04-05 17:44:11738extern unsigned long big_file_threshold;
Junio C Hamano568508e2011-10-28 21:48:40739extern unsigned long pack_size_limit_cfg;
Michael Haggertyafc711b2014-02-18 11:24:55740
Jeff King45439262016-09-13 03:24:23741/*
742 * Accessors for the core.sharedrepository config which lazy-load the value
743 * from the config (if not already set). The "reset" function can be
744 * used to unset "set" or cached value, meaning that the value will be loaded
745 * fresh from the config file on the next call to get_shared_repository().
746 */
Jeff King7875acb2016-03-11 22:36:49747void set_shared_repository(int value);
748int get_shared_repository(void);
Jeff King45439262016-09-13 03:24:23749void reset_shared_repository(void);
Jeff King7875acb2016-03-11 22:36:49750
Michael Haggertyafc711b2014-02-18 11:24:55751/*
752 * Do replace refs need to be checked this run? This variable is
753 * initialized to true unless --no-replace-object is used or
754 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
755 * commands that do not want replace references to be active. As an
756 * optimization it is also set to false if replace references have
757 * been sought but there were none.
758 */
759extern int check_replace_refs;
Mike Hommey58d121b2015-06-11 21:34:59760extern char *git_replace_ref_base;
Michael Haggertyafc711b2014-02-18 11:24:55761
Linus Torvaldsaafe9fb2008-06-18 22:18:44762extern int fsync_object_files;
Linus Torvalds671c9b72008-11-14 00:36:30763extern int core_preload_index;
Nguyễn Thái Ngọc Duy08aefc92009-08-20 13:47:08764extern int core_apply_sparse_checkout;
Torsten Bögershausen76759c72012-07-08 13:50:25765extern int precomposed_unicode;
Jeff Kinga42643a2014-12-15 23:15:20766extern int protect_hfs;
Johannes Schindelin2b4c6ef2014-12-16 22:46:59767extern int protect_ntfs;
Nguyễn Thái Ngọc Duyc7b3a3d2014-11-30 08:24:36768extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
Linus Torvalds17712992005-10-10 23:31:08769
Junio C Hamanoeff80a92013-01-16 19:18:48770/*
Jeff King49672f22015-03-20 18:43:06771 * Include broken refs in all ref iterations, which will
772 * generally choke dangerous operations rather than letting
773 * them silently proceed without taking the broken ref into
774 * account.
775 */
776extern int ref_paranoia;
777
778/*
Junio C Hamanoeff80a92013-01-16 19:18:48779 * The character that begins a commented line in user-editable file
780 * that is subject to stripspace.
781 */
782extern char comment_line_char;
Nguyễn Thái Ngọc Duy84c9dc22014-05-17 01:52:23783extern int auto_comment_line_char;
Junio C Hamanoeff80a92013-01-16 19:18:48784
Johannes Schindelinf30afda2016-05-11 08:43:37785/* Windows only */
786enum hide_dotfiles_type {
787 HIDE_DOTFILES_FALSE = 0,
788 HIDE_DOTFILES_TRUE,
789 HIDE_DOTFILES_DOTGITONLY
790};
791extern enum hide_dotfiles_type hide_dotfiles;
792
Cornelius Weig341fb282017-01-27 10:09:47793enum log_refs_config {
794 LOG_REFS_UNSET = -1,
795 LOG_REFS_NONE = 0,
796 LOG_REFS_NORMAL,
797 LOG_REFS_ALWAYS
798};
799extern enum log_refs_config log_all_ref_updates;
800
Jay Soffian9ed36cf2008-02-19 16:24:37801enum branch_track {
Alex Riesen9188ed82008-08-21 17:23:20802 BRANCH_TRACK_UNSPECIFIED = -1,
Jay Soffian9ed36cf2008-02-19 16:24:37803 BRANCH_TRACK_NEVER = 0,
804 BRANCH_TRACK_REMOTE,
805 BRANCH_TRACK_ALWAYS,
806 BRANCH_TRACK_EXPLICIT,
Gary V. Vaughan4b055482010-05-14 09:31:35807 BRANCH_TRACK_OVERRIDE
Jay Soffian9ed36cf2008-02-19 16:24:37808};
809
Dustin Sallingsc998ae92008-05-10 22:36:29810enum rebase_setup_type {
811 AUTOREBASE_NEVER = 0,
812 AUTOREBASE_LOCAL,
813 AUTOREBASE_REMOTE,
Gary V. Vaughan4b055482010-05-14 09:31:35814 AUTOREBASE_ALWAYS
Dustin Sallingsc998ae92008-05-10 22:36:29815};
816
Finn Arne Gangstad52153742009-03-16 15:42:51817enum push_default_type {
Finn Arne Gangstad52153742009-03-16 15:42:51818 PUSH_DEFAULT_NOTHING = 0,
819 PUSH_DEFAULT_MATCHING,
Matthieu Moyb55e67752012-04-24 07:50:03820 PUSH_DEFAULT_SIMPLE,
Johan Herland53c40312011-02-16 00:54:24821 PUSH_DEFAULT_UPSTREAM,
Christopher Tiwaldf25950f2012-03-20 04:31:33822 PUSH_DEFAULT_CURRENT,
823 PUSH_DEFAULT_UNSPECIFIED
Finn Arne Gangstad52153742009-03-16 15:42:51824};
825
Jay Soffian9ed36cf2008-02-19 16:24:37826extern enum branch_track git_branch_track;
Dustin Sallingsc998ae92008-05-10 22:36:29827extern enum rebase_setup_type autorebase;
Finn Arne Gangstad52153742009-03-16 15:42:51828extern enum push_default_type push_default;
Jay Soffian9ed36cf2008-02-19 16:24:37829
Johannes Schindelin348df162009-04-27 22:32:25830enum object_creation_mode {
831 OBJECT_CREATION_USES_HARDLINKS = 0,
Gary V. Vaughan4b055482010-05-14 09:31:35832 OBJECT_CREATION_USES_RENAMES = 1
Johannes Schindelin348df162009-04-27 22:32:25833};
834
835extern enum object_creation_mode object_creation_mode;
Johannes Schindelinbe66a6c2009-04-25 09:57:14836
Johannes Schindelina97a7462009-10-09 10:21:57837extern char *notes_ref_name;
838
Johannes Schindelin7f3140c2009-07-23 15:33:49839extern int grafts_replace_parents;
840
Jeff King00a09d52015-06-23 10:53:58841/*
842 * GIT_REPO_VERSION is the version we write by default. The
843 * _READ variant is the highest number we know how to
844 * handle.
845 */
Junio C Hamanoab9cb762005-11-25 23:59:09846#define GIT_REPO_VERSION 0
Jeff King00a09d52015-06-23 10:53:58847#define GIT_REPO_VERSION_READ 1
Jeff King067fbd42015-06-23 10:54:11848extern int repository_format_precious_objects;
Jeff King4b0d1ee2016-03-11 22:36:45849
Jeff King2cc7c2c2016-03-11 22:37:07850struct repository_format {
851 int version;
852 int precious_objects;
853 int is_bare;
854 char *work_tree;
855 struct string_list unknown_extensions;
856};
857
858/*
859 * Read the repository format characteristics from the config file "path" into
860 * "format" struct. Returns the numeric version. On error, -1 is returned,
861 * format->version is set to -1, and all other fields in the struct are
862 * undefined.
863 */
864int read_repository_format(struct repository_format *format, const char *path);
865
866/*
867 * Verify that the repository described by repository_format is something we
868 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
869 * any errors encountered.
870 */
871int verify_repository_format(const struct repository_format *format,
872 struct strbuf *err);
873
Jeff King4b0d1ee2016-03-11 22:36:45874/*
875 * Check the repository format version in the path found in get_git_dir(),
876 * and die if it is a version we don't understand. Generally one would
877 * set_git_dir() before calling this, and use it only for "are we in a valid
878 * repo?".
879 */
880extern void check_repository_format(void);
Junio C Hamanoab9cb762005-11-25 23:59:09881
Linus Torvalds734aab72005-04-09 16:48:20882#define MTIME_CHANGED 0x0001
883#define CTIME_CHANGED 0x0002
884#define OWNER_CHANGED 0x0004
885#define MODE_CHANGED 0x0008
886#define INODE_CHANGED 0x0010
887#define DATA_CHANGED 0x0020
Kay Sievers8ae0a8c2005-05-05 12:38:25888#define TYPE_CHANGED 0x0040
Linus Torvaldse83c5162005-04-07 22:13:13889
Jeff King69ddd232015-08-10 09:32:07890/*
891 * Return a statically allocated filename, either generically (mkpath), in
892 * the repository directory (git_path), or in a submodule's repository
893 * directory (git_path_submodule). In all cases, note that the result
894 * may be overwritten by another call to _any_ of the functions. Consider
Jeff King07e30702015-08-10 09:36:27895 * using the safer "dup" or "strbuf" formats below (in some cases, the
896 * unsafe versions have already been removed).
Jeff King69ddd232015-08-10 09:32:07897 */
898extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
899extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
Nguyễn Thái Ngọc Duy15cdfea2016-04-22 13:01:25900extern const char *git_common_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
Jeff King69ddd232015-08-10 09:32:07901
Alex Riesen108bebe2008-10-26 21:59:13902extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
903 __attribute__((format (printf, 3, 4)));
Nguyễn Thái Ngọc Duy1a83c242014-11-30 08:24:28904extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
905 __attribute__((format (printf, 2, 3)));
Nguyễn Thái Ngọc Duy15cdfea2016-04-22 13:01:25906extern void strbuf_git_common_path(struct strbuf *sb, const char *fmt, ...)
907 __attribute__((format (printf, 2, 3)));
Jeff Kingbb3788c2015-09-24 21:05:40908extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
909 __attribute__((format (printf, 2, 3)));
Jacob Keller99b43a62016-08-31 23:27:22910extern int strbuf_git_path_submodule(struct strbuf *sb, const char *path,
911 const char *fmt, ...)
Jeff Kingf5895fd2015-08-10 09:32:22912 __attribute__((format (printf, 3, 4)));
Alex Riesenaba13e72008-10-27 10:17:51913extern char *git_pathdup(const char *fmt, ...)
914 __attribute__((format (printf, 1, 2)));
Huynh Khoi Nguyen Nguyen21cf3222012-06-22 09:03:23915extern char *mkpathdup(const char *fmt, ...)
916 __attribute__((format (printf, 1, 2)));
Jeff Kingf5895fd2015-08-10 09:32:22917extern char *git_pathdup_submodule(const char *path, const char *fmt, ...)
Heiko Voigt0bad6112010-07-07 13:39:11918 __attribute__((format (printf, 2, 3)));
Alex Riesen108bebe2008-10-26 21:59:13919
Nguyễn Thái Ngọc Duy77a6d842014-11-30 08:24:54920extern void report_linked_checkout_garbage(void);
Heiko Voigt0bad6112010-07-07 13:39:11921
Michael Haggertyd40d5352014-02-21 16:32:06922/*
Jeff Kingf9327292015-08-10 09:38:57923 * You can define a static memoized git path like:
924 *
925 * static GIT_PATH_FUNC(git_path_foo, "FOO");
926 *
927 * or use one of the global ones below.
928 */
929#define GIT_PATH_FUNC(func, filename) \
930 const char *func(void) \
931 { \
932 static char *ret; \
933 if (!ret) \
934 ret = git_pathdup(filename); \
935 return ret; \
936 }
937
938const char *git_path_cherry_pick_head(void);
939const char *git_path_revert_head(void);
940const char *git_path_squash_msg(void);
941const char *git_path_merge_msg(void);
942const char *git_path_merge_rr(void);
943const char *git_path_merge_mode(void);
944const char *git_path_merge_head(void);
945const char *git_path_fetch_head(void);
946const char *git_path_shallow(void);
947
948/*
Michael Haggertyd40d5352014-02-21 16:32:06949 * Return the name of the file in the local object database that would
950 * be used to store a loose object with the specified sha1. The
951 * return value is a pointer to a statically allocated buffer that is
952 * overwritten each time the function is called.
953 */
Michael Haggerty30d6c6e2014-02-21 16:32:05954extern const char *sha1_file_name(const unsigned char *sha1);
Michael Haggertyd40d5352014-02-21 16:32:06955
956/*
957 * Return the name of the (local) packfile with the specified sha1 in
958 * its name. The return value is a pointer to memory that is
959 * overwritten each time this function is called.
960 */
barkalow@iabervon.orgbf592c52005-08-01 00:53:44961extern char *sha1_pack_name(const unsigned char *sha1);
Michael Haggertyd40d5352014-02-21 16:32:06962
963/*
964 * Return the name of the (local) pack index file with the specified
965 * sha1 in its name. The return value is a pointer to memory that is
966 * overwritten each time this function is called.
967 */
barkalow@iabervon.orgbf592c52005-08-01 00:53:44968extern char *sha1_pack_index_name(const unsigned char *sha1);
Michael Haggertyd40d5352014-02-21 16:32:06969
Jeff Kingaf49c6d2015-09-24 21:05:45970/*
971 * Return an abbreviated sha1 unique within this repository's object database.
972 * The result will be at least `len` characters long, and will be NUL
973 * terminated.
974 *
Jeff Kingef2ed502016-10-20 06:19:19975 * The non-`_r` version returns a static buffer which remains valid until 4
976 * more calls to find_unique_abbrev are made.
Jeff Kingaf49c6d2015-09-24 21:05:45977 *
978 * The `_r` variant writes to a buffer supplied by the caller, which must be at
979 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
980 * written (excluding the NUL terminator).
981 *
982 * Note that while this version avoids the static buffer, it is not fully
983 * reentrant, as it calls into other non-reentrant git code.
984 */
985extern const char *find_unique_abbrev(const unsigned char *sha1, int len);
986extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len);
987
brian m. carlsoncd025992017-03-26 16:01:25988extern const unsigned char null_sha1[GIT_MAX_RAWSZ];
brian m. carlson3e56e722015-12-06 22:16:35989extern const struct object_id null_oid;
Ingo Molnar1a812f32011-04-28 10:19:02990
David Rientjesa89fccd2006-08-17 18:54:57991static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
992{
Ingo Molnar1a812f32011-04-28 10:19:02993 int i;
994
brian m. carlsonaa1c6fd2015-03-13 23:39:28995 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
Ingo Molnar1a812f32011-04-28 10:19:02996 if (*sha1 != *sha2)
997 return *sha1 - *sha2;
998 }
999
1000 return 0;
David Rientjesa89fccd2006-08-17 18:54:571001}
Ingo Molnar1a812f32011-04-28 10:19:021002
brian m. carlsonaa1c6fd2015-03-13 23:39:281003static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
1004{
1005 return hashcmp(oid1->hash, oid2->hash);
1006}
1007
Ingo Molnar1a812f32011-04-28 10:19:021008static inline int is_null_sha1(const unsigned char *sha1)
1009{
1010 return !hashcmp(sha1, null_sha1);
1011}
1012
brian m. carlsonaa1c6fd2015-03-13 23:39:281013static inline int is_null_oid(const struct object_id *oid)
1014{
1015 return !hashcmp(oid->hash, null_sha1);
1016}
1017
Shawn Pearcee7024962006-08-23 06:49:001018static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
1019{
brian m. carlsonaa1c6fd2015-03-13 23:39:281020 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
Shawn Pearcee7024962006-08-23 06:49:001021}
brian m. carlsonaa1c6fd2015-03-13 23:39:281022
1023static inline void oidcpy(struct object_id *dst, const struct object_id *src)
1024{
1025 hashcpy(dst->hash, src->hash);
1026}
1027
Junio C Hamanoa8e0d162006-08-23 20:57:231028static inline void hashclr(unsigned char *hash)
1029{
brian m. carlsonaa1c6fd2015-03-13 23:39:281030 memset(hash, 0, GIT_SHA1_RAWSZ);
Junio C Hamanoa8e0d162006-08-23 20:57:231031}
Linus Torvaldse83c5162005-04-07 22:13:131032
brian m. carlsonaa1c6fd2015-03-13 23:39:281033static inline void oidclr(struct object_id *oid)
1034{
1035 hashclr(oid->hash);
1036}
1037
1038
Jeff King14d9c572008-11-12 08:17:521039#define EMPTY_TREE_SHA1_HEX \
1040 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
Jonathan Niederdab0d412011-02-07 08:17:271041#define EMPTY_TREE_SHA1_BIN_LITERAL \
Jeff King14d9c572008-11-12 08:17:521042 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
1043 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
Jacob Keller8576fde2016-08-31 23:27:181044extern const struct object_id empty_tree_oid;
1045#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)
Jeff King14d9c572008-11-12 08:17:521046
Jeff Kingf8582ca2012-03-22 18:53:391047#define EMPTY_BLOB_SHA1_HEX \
1048 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
1049#define EMPTY_BLOB_SHA1_BIN_LITERAL \
1050 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
1051 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
Jacob Keller8576fde2016-08-31 23:27:181052extern const struct object_id empty_blob_oid;
1053#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)
1054
Jeff Kingf8582ca2012-03-22 18:53:391055
1056static inline int is_empty_blob_sha1(const unsigned char *sha1)
1057{
1058 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
1059}
1060
Jacob Keller8576fde2016-08-31 23:27:181061static inline int is_empty_blob_oid(const struct object_id *oid)
1062{
1063 return !hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);
1064}
1065
1066static inline int is_empty_tree_sha1(const unsigned char *sha1)
1067{
1068 return !hashcmp(sha1, EMPTY_TREE_SHA1_BIN);
1069}
1070
1071static inline int is_empty_tree_oid(const struct object_id *oid)
1072{
1073 return !hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);
1074}
1075
Matthieu Moyb862b612010-02-22 22:32:131076/* set default permissions by passing mode arguments to open(2) */
1077int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
1078int git_mkstemp_mode(char *pattern, int mode);
1079
Heikki Orsila06cbe852008-04-16 08:34:241080/*
1081 * NOTE NOTE NOTE!!
1082 *
1083 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1084 * not be changed. Old repositories have core.sharedrepository written in
1085 * numeric format, and therefore these values are preserved for compatibility
1086 * reasons.
1087 */
Junio C Hamano94df2502006-06-10 06:09:491088enum sharedrepo {
Heikki Orsila06cbe852008-04-16 08:34:241089 PERM_UMASK = 0,
1090 OLD_PERM_GROUP = 1,
1091 OLD_PERM_EVERYBODY = 2,
1092 PERM_GROUP = 0660,
Gary V. Vaughan4b055482010-05-14 09:31:351093 PERM_EVERYBODY = 0664
Junio C Hamano94df2502006-06-10 06:09:491094};
1095int git_config_perm(const char *var, const char *value);
Torsten Bögershausen3a429d32013-03-30 09:53:321096int adjust_shared_perm(const char *path);
Michael Haggerty0be05212014-01-06 13:45:251097
1098/*
1099 * Create the directory containing the named path, using care to be
Michael Haggerty204a0472017-01-06 16:22:251100 * somewhat safe against races. Return one of the scld_error values to
1101 * indicate success/failure. On error, set errno to describe the
1102 * problem.
Michael Haggerty18d37e82014-01-06 13:45:271103 *
1104 * SCLD_VANISHED indicates that one of the ancestor directories of the
1105 * path existed at one point during the function call and then
1106 * suddenly vanished, probably because another process pruned the
1107 * directory while we were working. To be robust against this kind of
1108 * race, callers might want to try invoking the function again when it
1109 * returns SCLD_VANISHED.
Michael Haggertye95792e2016-04-24 02:34:121110 *
1111 * safe_create_leading_directories() temporarily changes path while it
1112 * is working but restores it before returning.
1113 * safe_create_leading_directories_const() doesn't modify path, even
1114 * temporarily.
Michael Haggerty0be05212014-01-06 13:45:251115 */
1116enum scld_error {
1117 SCLD_OK = 0,
1118 SCLD_FAILED = -1,
1119 SCLD_PERMS = -2,
Michael Haggerty18d37e82014-01-06 13:45:271120 SCLD_EXISTS = -3,
1121 SCLD_VANISHED = -4
Michael Haggerty0be05212014-01-06 13:45:251122};
1123enum scld_error safe_create_leading_directories(char *path);
1124enum scld_error safe_create_leading_directories_const(const char *path);
1125
Michael Haggerty177978f2017-01-06 16:22:261126/*
1127 * Callback function for raceproof_create_file(). This function is
1128 * expected to do something that makes dirname(path) permanent despite
1129 * the fact that other processes might be cleaning up empty
1130 * directories at the same time. Usually it will create a file named
1131 * path, but alternatively it could create another file in that
1132 * directory, or even chdir() into that directory. The function should
1133 * return 0 if the action was completed successfully. On error, it
1134 * should return a nonzero result and set errno.
1135 * raceproof_create_file() treats two errno values specially:
1136 *
1137 * - ENOENT -- dirname(path) does not exist. In this case,
1138 * raceproof_create_file() tries creating dirname(path)
1139 * (and any parent directories, if necessary) and calls
1140 * the function again.
1141 *
1142 * - EISDIR -- the file already exists and is a directory. In this
1143 * case, raceproof_create_file() removes the directory if
1144 * it is empty (and recursively any empty directories that
1145 * it contains) and calls the function again.
1146 *
1147 * Any other errno causes raceproof_create_file() to fail with the
1148 * callback's return value and errno.
1149 *
1150 * Obviously, this function should be OK with being called again if it
1151 * fails with ENOENT or EISDIR. In other scenarios it will not be
1152 * called again.
1153 */
1154typedef int create_file_fn(const char *path, void *cb);
1155
1156/*
1157 * Create a file in dirname(path) by calling fn, creating leading
1158 * directories if necessary. Retry a few times in case we are racing
1159 * with another process that is trying to clean up the directory that
1160 * contains path. See the documentation for create_file_fn for more
1161 * details.
1162 *
1163 * Return the value and set the errno that resulted from the most
1164 * recent call of fn. fn is always called at least once, and will be
1165 * called more than once if it returns ENOENT or EISDIR.
1166 */
1167int raceproof_create_file(const char *path, create_file_fn fn, void *cb);
1168
Junio C Hamano90a64642011-03-11 00:02:501169int mkdir_in_gitdir(const char *path);
Nguyễn Thái Ngọc Duy4aad2f12017-04-05 10:24:381170extern char *expand_user_path(const char *path, int real_home);
Erik Faye-Lund1c64b482011-10-04 20:02:001171const char *enter_repo(const char *path, int strict);
Johannes Schindeline5392c52007-08-01 00:28:591172static inline int is_absolute_path(const char *path)
1173{
Theo Niessink88135202011-05-27 16:00:381174 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
Johannes Schindeline5392c52007-08-01 00:28:591175}
Junio C Hamano90b4a712008-09-09 08:27:071176int is_directory(const char *);
Brandon Williamsa1ae4842016-12-12 18:16:531177char *strbuf_realpath(struct strbuf *resolved, const char *path,
1178 int die_on_error);
Carlos Martín Nietoe2a57aa2011-03-17 11:26:461179const char *real_path(const char *path);
Michael Haggertye3e46cd2012-10-28 16:16:221180const char *real_path_if_valid(const char *path);
Johannes Schindelince83ead2017-03-08 15:43:401181char *real_pathdup(const char *path, int die_on_error);
Carlos Martín Nietoe2a57aa2011-03-17 11:26:461182const char *absolute_path(const char *path);
René Scharfeb1edb402017-01-26 17:47:451183char *absolute_pathdup(const char *path);
Jiang Xin41894ae2013-10-14 02:29:401184const char *remove_leading_path(const char *in, const char *prefix);
Jiang Xine02ca722013-06-25 15:53:431185const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
Nguyễn Thái Ngọc Duy645a29c2013-07-14 08:36:031186int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
Johannes Sixtf3cad0a2009-02-07 15:08:281187int normalize_path_copy(char *dst, const char *src);
Michael Haggerty31171d92012-10-28 16:16:241188int longest_ancestor_length(const char *path, struct string_list *prefixes);
Johannes Schindelin4fcc86b2009-02-19 19:10:491189char *strip_path_suffix(const char *path, const char *suffix);
Shawn O. Pearce34b6cb82009-11-09 19:26:431190int daemon_avoid_alias(const char *path);
Johannes Schindelin1d1d69b2014-12-16 22:31:031191extern int is_ntfs_dotgit(const char *name);
Junio C Hamanob2cb9422005-07-06 08:11:521192
Paul Tanea192892015-04-21 04:06:271193/**
1194 * Return a newly allocated string with the evaluation of
1195 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1196 * "$HOME/.config/git/$filename". Return NULL upon error.
1197 */
1198extern char *xdg_config_home(const char *filename);
1199
Devin Lehmachere7f136b2017-03-13 20:43:541200/**
1201 * Return a newly allocated string with the evaluation of
1202 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
1203 * "$HOME/.cache/git/$filename". Return NULL upon error.
1204 */
1205extern char *xdg_cache_home(const char *filename);
1206
Junio C Hamanoe1111ce2011-05-15 19:54:531207/* object replacement */
Christian Couderffe68cf2013-12-11 07:46:041208#define LOOKUP_REPLACE_OBJECT 1
Karthik Nayak46f03442015-05-03 14:29:591209#define LOOKUP_UNKNOWN_OBJECT 2
Junio C Hamano5bf29b92011-05-15 19:54:541210extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
Christian Couderf5552ae2009-01-23 09:07:011211static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
1212{
Christian Couderffe68cf2013-12-11 07:46:041213 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
Christian Couderf5552ae2009-01-23 09:07:011214}
Michael Haggerty1f91e792014-02-28 16:29:161215
1216/*
1217 * This internal function is only declared here for the benefit of
1218 * lookup_replace_object(). Please do not call it directly.
1219 */
Junio C Hamanoe1111ce2011-05-15 19:54:531220extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
Michael Haggerty1f91e792014-02-28 16:29:161221
1222/*
1223 * If object sha1 should be replaced, return the replacement object's
1224 * name (replaced recursively, if necessary). The return value is
1225 * either sha1 or a pointer to a permanently-allocated value. When
1226 * object replacement is suppressed, always return sha1.
1227 */
Junio C Hamanoe1111ce2011-05-15 19:54:531228static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1229{
Michael Haggertyafc711b2014-02-18 11:24:551230 if (!check_replace_refs)
Junio C Hamanoe1111ce2011-05-15 19:54:531231 return sha1;
1232 return do_lookup_replace_object(sha1);
1233}
Michael Haggerty1f91e792014-02-28 16:29:161234
Christian Couderbf93eea2013-12-11 07:46:061235static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
1236{
1237 if (!(flag & LOOKUP_REPLACE_OBJECT))
1238 return sha1;
1239 return lookup_replace_object(sha1);
1240}
Junio C Hamanoe1111ce2011-05-15 19:54:531241
Linus Torvaldse83c5162005-04-07 22:13:131242/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
Nicolas Pitre21666f12007-02-26 19:55:591243extern int sha1_object_info(const unsigned char *, unsigned long *);
Nicolas Pitrece9fbf12007-03-20 20:02:091244extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
Jeff Kingc00e6572010-04-02 00:03:181245extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
Eric Sunshine0c3db672015-05-04 07:25:151246extern 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:591247extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
Nicolas Pitrebbac7312008-05-14 05:32:481248extern int force_object_loose(const unsigned char *sha1, time_t mtime);
Junio C Hamano1b8ac5e2016-10-28 13:23:071249extern int git_open_cloexec(const char *name, int flags);
Junio C Hamanob4d065d2016-10-28 13:29:271250#define git_open(name) git_open_cloexec(name, O_RDONLY)
Junio C Hamanof0270ef2011-05-15 02:42:101251extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
Junio C Hamanoeb4f4072011-07-19 16:33:031252extern 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:101253extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
Daniel Barkalow8237b182005-04-24 01:47:231254
Nicolas Pitre0e8189e2008-10-31 15:31:081255/* global flag to enable extra checks when accessing packed objects */
1256extern int do_check_packed_object_crc;
1257
Jason McMullan5d6ccf52005-06-03 15:05:391258extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
Linus Torvaldse83c5162005-04-07 22:13:131259
Junio C Hamanocb5add52015-08-07 21:40:241260extern int finalize_object_file(const char *tmpfile, const char *filename);
Daniel Barkalow8237b182005-04-24 01:47:231261
Junio C Hamanocd673c12009-02-28 07:15:531262extern int has_sha1_pack(const unsigned char *sha1);
Michael Haggertyd40d5352014-02-21 16:32:061263
1264/*
Jeff Kingf6371f92017-01-13 17:58:161265 * Open the loose object at path, check its sha1, and return the contents,
1266 * type, and size. If the object is a blob, then "contents" may return NULL,
1267 * to allow streaming of large blobs.
1268 *
1269 * Returns 0 on success, negative on error (details may be written to stderr).
1270 */
1271int read_loose_object(const char *path,
1272 const unsigned char *expected_sha1,
1273 enum object_type *type,
1274 unsigned long *size,
1275 void **contents);
1276
1277/*
Michael Haggertyd40d5352014-02-21 16:32:061278 * Return true iff we have an object named sha1, whether local or in
1279 * an alternate object database, and whether packed or loose. This
1280 * function does not respect replace references.
Jeff King0eeb0772015-06-09 17:24:371281 *
1282 * If the QUICK flag is set, do not re-check the pack directory
1283 * when we cannot find the object (this means we may give a false
1284 * negative answer if another process is simultaneously repacking).
Michael Haggertyd40d5352014-02-21 16:32:061285 */
Jeff King0eeb0772015-06-09 17:24:371286#define HAS_SHA1_QUICK 0x1
1287extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1288static inline int has_sha1_file(const unsigned char *sha1)
1289{
1290 return has_sha1_file_with_flags(sha1, 0);
1291}
Michael Haggertyd40d5352014-02-21 16:32:061292
brian m. carlsonb419aa22015-11-10 02:22:191293/* Same as the above, except for struct object_id. */
1294extern int has_object_file(const struct object_id *oid);
Jeff King5827a032016-10-13 16:53:441295extern int has_object_file_with_flags(const struct object_id *oid, int flags);
brian m. carlsonb419aa22015-11-10 02:22:191296
Michael Haggertyd40d5352014-02-21 16:32:061297/*
1298 * Return true iff an alternate object database has a loose object
1299 * with the specified name. This function does not respect replace
1300 * references.
1301 */
Brandon Casey0f4dc142008-11-10 05:59:571302extern int has_loose_object_nonlocal(const unsigned char *sha1);
Daniel Barkalow8237b182005-04-24 01:47:231303
barkalow@iabervon.orgbf592c52005-08-01 00:53:441304extern int has_pack_index(const unsigned char *sha1);
1305
Jeff King40d52ff2010-04-02 00:05:231306extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1307
Christian Couder6a5e6f52017-02-27 18:00:111308/* Helper to check and "touch" a file */
1309extern int check_and_freshen_file(const char *fn, int freshen);
1310
Linus Torvalds192a6be2007-05-30 17:32:191311extern const signed char hexval_table[256];
1312static inline unsigned int hexval(unsigned char c)
Junio C Hamanoe49521b2006-09-20 23:04:461313{
1314 return hexval_table[c];
1315}
1316
René Scharfed2330972016-09-03 15:59:201317/*
1318 * Convert two consecutive hexadecimal digits into a char. Return a
1319 * negative value on error. Don't run over the end of short strings.
1320 */
1321static inline int hex2chr(const char *s)
1322{
1323 int val = hexval(s[0]);
1324 return (val < 0) ? val : (val << 4) | hexval(s[1]);
1325}
1326
Linus Torvaldse83c5162005-04-07 22:13:131327/* Convert to/from hex/sha1 representation */
Linus Torvaldsdce96482010-10-28 18:28:041328#define MINIMUM_ABBREV minimum_abbrev
1329#define DEFAULT_ABBREV default_abbrev
Junio C Hamano46a6c262006-01-25 09:03:181330
Junio C Hamano65acfea2016-10-01 00:19:351331/* used when the code does not know or care what the default abbrev is */
1332#define FALLBACK_DEFAULT_ABBREV 7
1333
Clément Poulain573285e2010-06-09 17:02:061334struct object_context {
1335 unsigned char tree[20];
Clément Poulain573285e2010-06-09 17:02:061336 unsigned mode;
David Turnerc4ec9672015-05-20 17:03:391337 /*
1338 * symlink_path is only used by get_tree_entry_follow_symlinks,
1339 * and only for symlinks that point outside the repository.
1340 */
1341 struct strbuf symlink_path;
Jeff Kingdc944b62017-05-19 12:54:431342 /*
1343 * If GET_SHA1_RECORD_PATH is set, this will record path (if any)
1344 * found when resolving the name. The caller is responsible for
1345 * releasing the memory.
1346 */
1347 char *path;
Clément Poulain573285e2010-06-09 17:02:061348};
1349
David Turnerc4ec9672015-05-20 17:03:391350#define GET_SHA1_QUIETLY 01
1351#define GET_SHA1_COMMIT 02
1352#define GET_SHA1_COMMITTISH 04
1353#define GET_SHA1_TREE 010
1354#define GET_SHA1_TREEISH 020
1355#define GET_SHA1_BLOB 040
1356#define GET_SHA1_FOLLOW_SYMLINKS 0100
Jeff Kingdc944b62017-05-19 12:54:431357#define GET_SHA1_RECORD_PATH 0200
David Turnerc4ec9672015-05-20 17:03:391358#define GET_SHA1_ONLY_TO_DIE 04000
Junio C Hamano37c00e52012-06-18 18:32:031359
Jeff King259942f2016-09-26 11:59:011360#define GET_SHA1_DISAMBIGUATORS \
1361 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \
1362 GET_SHA1_TREE | GET_SHA1_TREEISH | \
1363 GET_SHA1_BLOB)
1364
Linus Torvalds3c249c92005-05-01 23:36:561365extern int get_sha1(const char *str, unsigned char *sha1);
Junio C Hamanodaba53a2012-07-03 06:35:051366extern int get_sha1_commit(const char *str, unsigned char *sha1);
Junio C Hamanocd74e472012-07-02 19:04:521367extern int get_sha1_committish(const char *str, unsigned char *sha1);
Junio C Hamanodaba53a2012-07-03 06:35:051368extern int get_sha1_tree(const char *str, unsigned char *sha1);
1369extern int get_sha1_treeish(const char *str, unsigned char *sha1);
1370extern int get_sha1_blob(const char *str, unsigned char *sha1);
Junio C Hamano8c135ea2012-07-02 18:01:251371extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
Jeff Kingc0a487e2017-05-19 12:52:061372extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *oc);
Michael Haggertyd4e85a12011-09-23 13:38:361373
brian m. carlson2764fd92016-04-17 23:10:361374extern int get_oid(const char *str, struct object_id *oid);
1375
brian m. carlson1b7ba792017-03-31 01:39:591376typedef int each_abbrev_fn(const struct object_id *oid, void *);
Junio C Hamano957d7402012-07-03 21:21:591377extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
Michael Haggertyd4e85a12011-09-23 13:38:361378
Jeff King5b33cb12016-09-27 12:38:011379extern int set_disambiguate_hint_config(const char *var, const char *value);
1380
Michael Haggertyd4e85a12011-09-23 13:38:361381/*
1382 * Try to read a SHA1 in hexadecimal format from the 40 characters
1383 * starting at hex. Write the 20-byte result to sha1 in binary form.
1384 * Return 0 on success. Reading stops if a NUL is encountered in the
1385 * input, so it is safe to pass this function an arbitrary
1386 * null-terminated string.
1387 */
Linus Torvalds197ee8c2005-04-09 19:09:271388extern int get_sha1_hex(const char *hex, unsigned char *sha1);
brian m. carlsonaa1c6fd2015-03-13 23:39:281389extern int get_oid_hex(const char *hex, struct object_id *sha1);
Michael Haggertyd4e85a12011-09-23 13:38:361390
Jeff Kingaf49c6d2015-09-24 21:05:451391/*
1392 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1393 * and writes the NUL-terminated output to the buffer `out`, which must be at
1394 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1395 * convenience.
1396 *
1397 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1398 * buffers, making it safe to make multiple calls for a single statement, like:
1399 *
1400 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1401 */
1402extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
brian m. carlson55c529a2016-06-24 23:09:191403extern char *oid_to_hex_r(char *out, const struct object_id *oid);
Linus Torvalds197ee8c2005-04-09 19:09:271404extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
brian m. carlsonaa1c6fd2015-03-13 23:39:281405extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
Michael Haggerty7cb36842011-09-15 21:10:421406
Jeff Kinge322b602017-03-02 08:21:231407/*
brian m. carlson605f4302017-02-20 00:10:131408 * Parse a 40-character hexadecimal object ID starting from hex, updating the
1409 * pointer specified by end when parsing stops. The resulting object ID is
1410 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or
1411 * other invalid character. end is only updated on success; otherwise, it is
1412 * unmodified.
1413 */
1414extern int parse_oid_hex(const char *hex, struct object_id *oid, const char **end);
1415
Junio C Hamanoe1fae932017-03-17 20:50:241416/*
Jeff Kinge322b602017-03-02 08:21:231417 * This reads short-hand syntax that not only evaluates to a commit
1418 * object name, but also can act as if the end user spelled the name
1419 * of the branch from the command line.
1420 *
1421 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1422 * places the name of the branch in the given buf and returns the
1423 * number of characters parsed if successful.
1424 *
1425 * - "<branch>@{upstream}" finds the name of the other ref that
1426 * <branch> is configured to merge with (missing <branch> defaults
1427 * to the current branch), and places the name of the branch in the
1428 * given buf and returns the number of characters parsed if
1429 * successful.
1430 *
1431 * If the input is not of the accepted format, it returns a negative
1432 * number to signal an error.
1433 *
1434 * If the input was ok but there are not N branch switches in the
1435 * reflog, it returns 0.
Jeff King0e9f62d2017-03-02 08:23:011436 *
1437 * If "allowed" is non-zero, it is a treated as a bitfield of allowable
1438 * expansions: local branches ("refs/heads/"), remote branches
1439 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
1440 * allowed, even ones to refs outside of those namespaces.
Jeff Kinge322b602017-03-02 08:21:231441 */
Jeff King0e9f62d2017-03-02 08:23:011442#define INTERPRET_BRANCH_LOCAL (1<<0)
1443#define INTERPRET_BRANCH_REMOTE (1<<1)
1444#define INTERPRET_BRANCH_HEAD (1<<2)
1445extern int interpret_branch_name(const char *str, int len, struct strbuf *,
1446 unsigned allowed);
brian m. carlson151b2912016-09-05 20:08:071447extern int get_oid_mb(const char *str, struct object_id *oid);
Junio C Hamanoe86eb662007-01-19 09:15:151448
Junio C Hamanoc847f532007-01-02 07:31:081449extern int validate_headref(const char *ref);
Linus Torvaldse83c5162005-04-07 22:13:131450
Linus Torvalds958ba6c2005-05-20 16:09:181451extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
Linus Torvalds0ab9e1e2008-03-06 02:25:101452extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
Jeremiah Mahlerccdd4a02014-06-20 02:06:441453extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
Thomas Gummererb60e1882012-07-11 09:22:371454extern 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:131455
Junio C Hamano40469ee2005-04-28 23:42:271456extern void *read_object_with_reference(const unsigned char *sha1,
Brian Gerstbf0f9102005-05-18 12:14:091457 const char *required_type,
Junio C Hamano40469ee2005-04-28 23:42:271458 unsigned long *size,
1459 unsigned char *sha1_ret);
Junio C Hamanof4913f92005-04-21 01:06:491460
Junio C Hamano81776312007-12-24 08:51:011461extern struct object *peel_to_type(const char *name, int namelen,
1462 struct object *o, enum object_type);
1463
Jeff Kinga5481a62015-06-25 16:55:021464struct date_mode {
1465 enum date_mode_type {
1466 DATE_NORMAL = 0,
1467 DATE_RELATIVE,
1468 DATE_SHORT,
Jeff Kinga5481a62015-06-25 16:55:021469 DATE_ISO8601,
1470 DATE_ISO8601_STRICT,
1471 DATE_RFC2822,
Jeff Kingaa1462c2015-06-25 16:55:451472 DATE_STRFTIME,
Jeff King642833d2016-07-22 19:51:491473 DATE_RAW,
1474 DATE_UNIX
Jeff Kinga5481a62015-06-25 16:55:021475 } type;
Jeff Kingaa1462c2015-06-25 16:55:451476 const char *strftime_fmt;
Jeff Kingadd00ba2015-09-03 21:48:591477 int local;
Junio C Hamano73013af2007-07-14 06:14:521478};
1479
Jeff Kinga5481a62015-06-25 16:55:021480/*
1481 * Convenience helper for passing a constant type, like:
1482 *
1483 * show_date(t, tz, DATE_MODE(NORMAL));
1484 */
1485#define DATE_MODE(t) date_mode_from_type(DATE_##t)
1486struct date_mode *date_mode_from_type(enum date_mode_type type);
1487
1488const char *show_date(unsigned long time, int timezone, const struct date_mode *mode);
Jonathan Nieder7d29afd2012-04-23 12:30:231489void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1490 struct strbuf *timebuf);
Jeff Kingc33ddc22014-08-27 07:57:081491int parse_date(const char *date, struct strbuf *out);
Jonathan Nieder9644c062010-07-15 16:22:571492int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
Junio C Hamano3d27b9b2013-04-17 22:38:081493int parse_expiry_date(const char *date, unsigned long *timestamp);
Jeff Kingc33ddc22014-08-27 07:57:081494void datestamp(struct strbuf *out);
Junio C Hamano93cfa7c2010-01-26 19:58:001495#define approxidate(s) approxidate_careful((s), NULL)
1496unsigned long approxidate_careful(const char *, int *);
Alex Riesen33012fc2009-08-31 02:26:051497unsigned long approxidate_relative(const char *date, const struct timeval *now);
Jeff Kinga5481a62015-06-25 16:55:021498void parse_date_format(const char *format, struct date_mode *mode);
Jeff King7ca36d92014-02-24 07:39:451499int date_overflows(unsigned long date);
Edgar Toernigecee9d92005-04-30 16:46:491500
Jeff Kingf9bc5732012-05-24 23:28:401501#define IDENT_STRICT 1
Jeff Kingb9f0ac12012-05-21 23:10:111502#define IDENT_NO_DATE 2
Jeff Kingc15e1982012-05-24 23:27:241503#define IDENT_NO_NAME 4
Junio C Hamano749be722006-02-19 04:31:051504extern const char *git_author_info(int);
1505extern const char *git_committer_info(int);
Junio C Hamano798123a2007-02-05 01:50:141506extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
Junio C Hamanod9ccfe72007-12-02 21:43:341507extern const char *fmt_name(const char *name, const char *email);
Matthieu Moy98305342014-07-25 19:11:341508extern const char *ident_default_name(void);
Jeff Kingbcb2b002012-05-21 23:09:431509extern const char *ident_default_email(void);
Jonathan Nieder44fcb492009-11-12 00:01:271510extern const char *git_editor(void);
Jonathan Nieder64778d22010-02-14 11:59:591511extern const char *git_pager(int stdout_is_tty);
Jeff King95979212012-05-21 23:09:541512extern int git_ident_config(const char *, const char *, void *);
Jeff King4d9c7e62016-08-01 19:37:001513extern void reset_ident_date(void);
Linus Torvalds6aa33f42005-07-12 18:49:271514
Junio C Hamano4b340cf2012-03-11 09:25:431515struct ident_split {
1516 const char *name_begin;
1517 const char *name_end;
1518 const char *mail_begin;
1519 const char *mail_end;
1520 const char *date_begin;
1521 const char *date_end;
1522 const char *tz_begin;
1523 const char *tz_end;
1524};
1525/*
1526 * Signals an success with 0, but time part of the result may be NULL
1527 * if the input lacks timestamp and zone
1528 */
1529extern int split_ident_line(struct ident_split *, const char *, int);
1530
Jeff King662cc302013-09-20 10:16:281531/*
Jeff Kingd1053242014-05-02 01:07:221532 * Like show_date, but pull the timestamp and tz parameters from
1533 * the ident_split. It will also sanity-check the values and produce
1534 * a well-known sentinel date if they appear bogus.
1535 */
Jeff Kinga5481a62015-06-25 16:55:021536const char *show_ident_date(const struct ident_split *id,
1537 const struct date_mode *mode);
Jeff Kingd1053242014-05-02 01:07:221538
1539/*
Jeff King662cc302013-09-20 10:16:281540 * Compare split idents for equality or strict ordering. Note that we
1541 * compare only the ident part of the line, ignoring any timestamp.
1542 *
1543 * Because there are two fields, we must choose one as the primary key; we
1544 * currently arbitrarily pick the email.
1545 */
1546extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1547
Linus Torvalds12dccc12005-06-06 04:59:541548struct checkout {
Nguyễn Thái Ngọc Duyd4a20242014-06-13 12:19:341549 struct index_state *istate;
Linus Torvalds12dccc12005-06-06 04:59:541550 const char *base_dir;
1551 int base_dir_len;
1552 unsigned force:1,
1553 quiet:1,
1554 not_new:1,
1555 refresh_cache:1;
1556};
René Scharfe68e3d622016-09-22 16:11:331557#define CHECKOUT_INIT { NULL, "" }
Linus Torvalds12dccc12005-06-06 04:59:541558
Junio C Hamanoaf2a6512013-10-23 17:52:421559#define TEMPORARY_FILENAME_LENGTH 25
Luiz Fernando N. Capitulinoefbc5832007-04-25 14:18:081560extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
Linus Torvaldsb9fd2842009-07-09 20:35:311561
1562struct cache_def {
Karsten Bleese7c73052014-07-04 22:41:461563 struct strbuf path;
Linus Torvaldsb9fd2842009-07-09 20:35:311564 int flags;
1565 int track_flags;
1566 int prefix_len_stat_func;
1567};
Karsten Bleese7c73052014-07-04 22:41:461568#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
Karsten Blees2a608392014-07-11 23:02:341569static inline void cache_def_clear(struct cache_def *cache)
Karsten Bleese7c73052014-07-04 22:41:461570{
1571 strbuf_release(&cache->path);
1572}
Linus Torvaldsb9fd2842009-07-09 20:35:311573
Kjetil Barvik57199892009-02-09 20:54:061574extern int has_symlink_leading_path(const char *name, int len);
Linus Torvaldsb9fd2842009-07-09 20:35:311575extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
Clemens Buchacherf66caaf2010-10-09 13:53:001576extern int check_leading_path(const char *name, int len);
Kjetil Barvik57199892009-02-09 20:54:061577extern int has_dirs_only_path(const char *name, int len, int prefix_len);
Kjetil Barvik78478922009-02-09 20:54:071578extern void schedule_dir_for_removal(const char *name, int len);
1579extern void remove_scheduled_dirs(void);
Linus Torvalds12dccc12005-06-06 04:59:541580
Junio C Hamano9a217f22005-06-28 21:56:571581extern struct alternate_object_database {
Junio C Hamanod5a63b92005-08-15 00:25:571582 struct alternate_object_database *next;
Jeff King597f9132016-10-03 20:35:511583
Jeff King38dbe5f2016-10-03 20:36:041584 /* see alt_scratch_buf() */
1585 struct strbuf scratch;
1586 size_t base_len;
Jeff King597f9132016-10-03 20:35:511587
1588 char path[FLEX_ARRAY];
Junio C Hamanod5a63b92005-08-15 00:25:571589} *alt_odb_list;
Junio C Hamano9a217f22005-06-28 21:56:571590extern void prepare_alt_odb(void);
Heiko Voigt5e736332012-05-14 16:24:451591extern void read_info_alternates(const char * relative_base, int depth);
Stefan Beller9eeea7d2016-08-15 21:53:241592extern char *compute_alternate_path(const char *path, struct strbuf *err);
Junio C Hamanod79796b2008-09-09 08:27:101593typedef int alt_odb_fn(struct alternate_object_database *, void *);
Jeff Kingfe1b2262014-10-15 22:33:131594extern int foreach_alt_odb(alt_odb_fn, void*);
Junio C Hamano9a217f22005-06-28 21:56:571595
Jeff Kinga5b34d22016-10-03 20:35:031596/*
Jeff King7f0fa2c2016-10-03 20:35:311597 * Allocate a "struct alternate_object_database" but do _not_ actually
1598 * add it to the list of alternates.
1599 */
1600struct alternate_object_database *alloc_alt_odb(const char *dir);
1601
1602/*
Jeff Kinga5b34d22016-10-03 20:35:031603 * Add the directory to the on-disk alternates file; the new entry will also
1604 * take effect in the current process.
1605 */
1606extern void add_to_alternates_file(const char *dir);
1607
1608/*
1609 * Add the directory to the in-memory list of alternates (along with any
1610 * recursive alternates it points to), but do not modify the on-disk alternates
1611 * file.
1612 */
1613extern void add_to_alternates_memory(const char *dir);
1614
Jeff King38dbe5f2016-10-03 20:36:041615/*
1616 * Returns a scratch strbuf pre-filled with the alternate object directory,
1617 * including a trailing slash, which can be used to access paths in the
1618 * alternate. Always use this over direct access to alt->scratch, as it
1619 * cleans up any previous use of the scratch buffer.
1620 */
1621extern struct strbuf *alt_scratch_buf(struct alternate_object_database *alt);
1622
Shawn O. Pearcec41ee582006-12-23 07:33:441623struct pack_window {
1624 struct pack_window *next;
1625 unsigned char *base;
1626 off_t offset;
1627 size_t len;
1628 unsigned int last_used;
1629 unsigned int inuse_cnt;
1630};
1631
Junio C Hamano9a217f22005-06-28 21:56:571632extern struct packed_git {
1633 struct packed_git *next;
Shawn O. Pearcec41ee582006-12-23 07:33:441634 struct pack_window *windows;
Shawn O. Pearce2dc3a232006-12-23 07:33:471635 off_t pack_size;
Nicolas Pitre57059092007-04-09 05:06:281636 const void *index_data;
1637 size_t index_size;
1638 uint32_t num_objects;
Nicolas Pitre8eca0b42008-06-24 01:23:391639 uint32_t num_bad_objects;
1640 unsigned char *bad_object_sha1;
Nicolas Pitre42873072007-03-16 20:42:501641 int index_version;
Nicolas Pitre57059092007-04-09 05:06:281642 time_t mtime;
Shawn O. Pearce9bc879c2006-12-23 07:34:011643 int pack_fd;
Brandon Casey8d259312008-11-12 17:59:031644 unsigned pack_local:1,
Shawn O. Pearced131b7a2011-03-02 18:01:541645 pack_keep:1,
Jeff Kingee1c6c32015-04-20 19:55:001646 freshened:1,
Shawn O. Pearced131b7a2011-03-02 18:01:541647 do_not_close:1;
barkalow@iabervon.orgbf592c52005-08-01 00:53:441648 unsigned char sha1[20];
Jeff King9d98bbf2015-12-21 06:20:331649 struct revindex_entry *revindex;
Junio C Hamano8f1d2e62006-01-07 09:33:541650 /* something like ".git/objects/pack/xxxxx.pack" */
1651 char pack_name[FLEX_ARRAY]; /* more */
Junio C Hamano9a217f22005-06-28 21:56:571652} *packed_git;
Junio C Hamanof3bf9222005-07-01 00:15:391653
Jeff Kinga73cdd22016-07-29 04:09:461654/*
1655 * A most-recently-used ordered version of the packed_git list, which can
1656 * be iterated instead of packed_git (and marked via mru_mark).
1657 */
1658struct mru;
1659extern struct mru *packed_git_mru;
1660
Junio C Hamanof3bf9222005-07-01 00:15:391661struct pack_entry {
Shawn O. Pearcec4001d92007-03-07 01:44:301662 off_t offset;
Junio C Hamanof3bf9222005-07-01 00:15:391663 unsigned char sha1[20];
1664 struct packed_git *p;
1665};
1666
Shawn O. Pearce7b644692010-04-19 14:23:081667extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
barkalow@iabervon.orgbf592c52005-08-01 00:53:441668
Junio C Hamano0a489b02015-08-13 18:02:521669/* A hook to report invalid files in pack directory */
1670#define PACKDIR_FILE_PACK 1
1671#define PACKDIR_FILE_IDX 2
1672#define PACKDIR_FILE_GARBAGE 4
1673extern void (*report_garbage)(unsigned seen_bits, const char *path);
Nguyễn Thái Ngọc Duy543c5ca2013-02-15 12:07:101674
Junio C Hamano9a217f22005-06-28 21:56:571675extern void prepare_packed_git(void);
Shawn Pearcefc04c412006-11-01 22:06:211676extern void reprepare_packed_git(void);
barkalow@iabervon.orgbf592c52005-08-01 00:53:441677extern void install_packed_git(struct packed_git *pack);
1678
Jeff King8e3f52d2016-10-03 23:47:281679/*
1680 * Give a rough count of objects in the repository. This sacrifices accuracy
1681 * for speed.
1682 */
1683unsigned long approximate_object_count(void);
1684
Junio C Hamanoa6080a02007-06-07 07:04:011685extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
barkalow@iabervon.orgbf592c52005-08-01 00:53:441686 struct packed_git *packs);
1687
Chris Wedgwood276bc2c2007-01-17 06:28:021688extern void pack_report(void);
Michael Haggertyd40d5352014-02-21 16:32:061689
1690/*
Jeff King892e7232017-03-28 19:45:251691 * Create a temporary file rooted in the object database directory, or
1692 * die on failure. The filename is taken from "pattern", which should have the
1693 * usual "XXXXXX" trailer, and the resulting filename is written into the
1694 * "template" buffer. Returns the open descriptor.
Jeff King82c9d662017-03-16 14:27:001695 */
Jeff King594fa992017-03-28 19:45:431696extern int odb_mkstemp(struct strbuf *template, const char *pattern);
Jeff King82c9d662017-03-16 14:27:001697
1698/*
Jeff King1cec8c62017-03-16 14:27:061699 * Generate the filename to be used for a pack file with checksum "sha1" and
1700 * extension "ext". The result is written into the strbuf "buf", overwriting
1701 * any existing contents. A pointer to buf->buf is returned as a convenience.
1702 *
1703 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"
1704 */
1705extern char *odb_pack_name(struct strbuf *buf, const unsigned char *sha1, const char *ext);
1706
1707/*
Jeff Kingeaeefc32017-03-16 14:27:121708 * Create a pack .keep file named "name" (which should generally be the output
1709 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1710 * error.
Jeff King82c9d662017-03-16 14:27:001711 */
Jeff Kingeaeefc32017-03-16 14:27:121712extern int odb_pack_keep(const char *name);
Jeff King82c9d662017-03-16 14:27:001713
1714/*
Michael Haggertyd40d5352014-02-21 16:32:061715 * mmap the index file for the specified packfile (if it is not
1716 * already mmapped). Return 0 on success.
1717 */
Shawn O. Pearced0798372007-05-26 05:24:191718extern int open_pack_index(struct packed_git *);
Michael Haggertyd40d5352014-02-21 16:32:061719
1720/*
1721 * munmap the index file for the specified packfile (if it is
1722 * currently mmapped).
1723 */
Shawn O. Pearcefa5fc152010-04-19 14:23:061724extern void close_pack_index(struct packed_git *);
Michael Haggertyd40d5352014-02-21 16:32:061725
Junio C Hamanoef49a7a2011-06-10 18:52:151726extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
Shawn O. Pearcec9ced052008-01-18 03:57:001727extern void close_pack_windows(struct packed_git *);
Johannes Schindelin38849a82015-10-06 13:18:341728extern void close_all_packs(void);
Shawn O. Pearce03e79c82006-12-23 07:34:081729extern void unuse_pack(struct pack_window **);
Shawn O. Pearce3d20c632009-02-10 21:36:121730extern void clear_delta_base_cache(void);
Jeff King48bcc1c2015-09-24 21:06:551731extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
Michael Haggertyd40d5352014-02-21 16:32:061732
1733/*
Jeff King47fe3f62016-02-25 14:22:521734 * Make sure that a pointer access into an mmap'd index file is within bounds,
1735 * and can provide at least 8 bytes of data.
1736 *
1737 * Note that this is only necessary for variable-length segments of the file
1738 * (like the 64-bit extended offset table), as we compare the size to the
1739 * fixed-length parts when we open the file.
1740 */
1741extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
1742
1743/*
Michael Haggertyd40d5352014-02-21 16:32:061744 * Return the SHA-1 of the nth object within the specified packfile.
1745 * Open the index if it is not already open. The return value points
1746 * at the SHA-1 within the mmapped index. Return NULL if there is an
1747 * error.
1748 */
1749extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
brian m. carlson068f85e2017-02-21 23:47:341750/*
1751 * Like nth_packed_object_sha1, but write the data into the object specified by
1752 * the the first argument. Returns the first argument on success, and NULL on
1753 * error.
1754 */
1755extern const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n);
Michael Haggertyd40d5352014-02-21 16:32:061756
1757/*
1758 * Return the offset of the nth object within the specified packfile.
1759 * The index must already be opened.
1760 */
1761extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1762
1763/*
1764 * If the object named sha1 is present in the specified packfile,
1765 * return its offset within the packfile; otherwise, return 0.
1766 */
1767extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1768
Jeff King4c080182011-10-14 18:03:481769extern int is_pack_valid(struct packed_git *);
Shawn O. Pearcec4001d92007-03-07 01:44:301770extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
Nicolas Pitre09ded042008-10-29 23:02:461771extern 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:561772extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
Junio C Hamanof8c8abc2011-05-13 22:33:331773extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
Junio C Hamano9a217f22005-06-28 21:56:571774
Jeff King27e1e222014-10-15 22:38:551775/*
1776 * Iterate over the files in the loose-object parts of the object
1777 * directory "path", triggering the following callbacks:
1778 *
1779 * - loose_object is called for each loose object we find.
1780 *
1781 * - loose_cruft is called for any files that do not appear to be
1782 * loose objects. Note that we only look in the loose object
1783 * directories "objects/[0-9a-f]{2}/", so we will not report
1784 * "objects/foobar" as cruft.
1785 *
1786 * - loose_subdir is called for each top-level hashed subdirectory
1787 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1788 * after the objects in the directory are processed.
1789 *
1790 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1791 * will end the iteration.
Jeff Kinge6f875e2015-02-09 01:13:221792 *
1793 * In the "buf" variant, "path" is a strbuf which will also be used as a
1794 * scratch buffer, but restored to its original contents before
1795 * the function returns.
Jeff King27e1e222014-10-15 22:38:551796 */
brian m. carlson76c1d9a2017-02-21 23:47:351797typedef int each_loose_object_fn(const struct object_id *oid,
Jeff King27e1e222014-10-15 22:38:551798 const char *path,
1799 void *data);
1800typedef int each_loose_cruft_fn(const char *basename,
1801 const char *path,
1802 void *data);
1803typedef int each_loose_subdir_fn(int nr,
1804 const char *path,
1805 void *data);
1806int for_each_loose_file_in_objdir(const char *path,
1807 each_loose_object_fn obj_cb,
1808 each_loose_cruft_fn cruft_cb,
1809 each_loose_subdir_fn subdir_cb,
1810 void *data);
Jeff Kinge6f875e2015-02-09 01:13:221811int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1812 each_loose_object_fn obj_cb,
1813 each_loose_cruft_fn cruft_cb,
1814 each_loose_subdir_fn subdir_cb,
1815 void *data);
Jeff King27e1e222014-10-15 22:38:551816
Jeff King660c8892014-10-15 22:41:211817/*
1818 * Iterate over loose and packed objects in both the local
Jeff King1385bb72015-03-27 11:32:411819 * repository and any alternates repositories (unless the
1820 * LOCAL_ONLY flag is set).
Jeff King660c8892014-10-15 22:41:211821 */
Jeff King1385bb72015-03-27 11:32:411822#define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
brian m. carlson76c1d9a2017-02-21 23:47:351823typedef int each_packed_object_fn(const struct object_id *oid,
Jeff King660c8892014-10-15 22:41:211824 struct packed_git *pack,
1825 uint32_t pos,
1826 void *data);
Jeff King1385bb72015-03-27 11:32:411827extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1828extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
Jeff King660c8892014-10-15 22:41:211829
Junio C Hamano9a490592011-05-12 22:51:381830struct object_info {
1831 /* Request */
Jeff King5b086402013-07-12 06:34:571832 enum object_type *typep;
Junio C Hamano9a490592011-05-12 22:51:381833 unsigned long *sizep;
Nguyễn Thái Ngọc Duy166df262016-07-13 15:43:591834 off_t *disk_sizep;
Jeff King5d642e72013-12-21 14:24:201835 unsigned char *delta_base_sha1;
Karthik Nayak46f03442015-05-03 14:29:591836 struct strbuf *typename;
Junio C Hamano9a490592011-05-12 22:51:381837
1838 /* Response */
1839 enum {
1840 OI_CACHED,
1841 OI_LOOSE,
Junio C Hamano5266d362011-05-13 20:20:431842 OI_PACKED,
1843 OI_DBCACHED
Junio C Hamano9a490592011-05-12 22:51:381844 } whence;
1845 union {
1846 /*
1847 * struct {
1848 * ... Nothing to expose in this case
1849 * } cached;
1850 * struct {
1851 * ... Nothing to expose in this case
1852 * } loose;
1853 */
1854 struct {
1855 struct packed_git *pack;
1856 off_t offset;
1857 unsigned int is_delta;
1858 } packed;
1859 } u;
1860};
Jeff King27b5c1a2016-08-11 09:24:351861
1862/*
1863 * Initializer for a "struct object_info" that wants no items. You may
1864 * also memset() the memory to all-zeroes.
1865 */
1866#define OBJECT_INFO_INIT {NULL}
1867
Christian Couderde7b5d62013-12-11 07:46:071868extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
Jeff Kingca79c982016-08-11 09:25:321869extern int packed_object_info(struct packed_git *pack, off_t offset, struct object_info *);
Junio C Hamano9a217f22005-06-28 21:56:571870
Junio C Hamano8f3f9b02005-07-24 00:54:411871/* Dumb servers support */
1872extern int update_server_info(int);
1873
Michael J Gruber7a397412011-05-17 15:38:521874/* git_config_parse_key() returns these negated: */
1875#define CONFIG_INVALID_KEY 1
1876#define CONFIG_NO_SECTION_OR_NAME 2
Patrick Steinhardt30598ad2016-02-22 11:23:351877/* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */
Michael J Gruber7a397412011-05-17 15:38:521878#define CONFIG_NO_LOCK -1
1879#define CONFIG_INVALID_FILE 3
1880#define CONFIG_NO_WRITE 4
1881#define CONFIG_NOTHING_SET 5
1882#define CONFIG_INVALID_PATTERN 6
Junio C Hamano9409c7a2012-07-29 20:43:211883#define CONFIG_GENERIC_ERROR 7
Michael J Gruber7a397412011-05-17 15:38:521884
Jeff Kingc1063be2014-08-19 06:20:001885#define CONFIG_REGEX_NONE ((void *)1)
1886
Kirill A. Shutemovc8985ce2014-02-18 22:58:541887struct git_config_source {
Kirill A. Shutemov3caec732014-02-18 22:58:551888 unsigned int use_stdin:1;
Kirill A. Shutemovc8985ce2014-02-18 22:58:541889 const char *file;
1890 const char *blob;
1891};
1892
Vasco Almeida1b8132d2016-07-28 13:14:031893enum config_origin_type {
1894 CONFIG_ORIGIN_BLOB,
1895 CONFIG_ORIGIN_FILE,
1896 CONFIG_ORIGIN_STDIN,
1897 CONFIG_ORIGIN_SUBMODULE_BLOB,
1898 CONFIG_ORIGIN_CMDLINE
1899};
1900
Nguyễn Thái Ngọc Duyc48f4b32017-04-17 10:10:001901struct config_options {
1902 unsigned int respect_includes : 1;
Nguyễn Thái Ngọc Duy2185fde2017-04-17 10:10:011903 const char *git_dir;
Nguyễn Thái Ngọc Duyc48f4b32017-04-17 10:10:001904};
1905
Johannes Schindelinef90d6d2008-05-14 17:46:531906typedef int (*config_fn_t)(const char *, const char *, void *);
1907extern int git_default_config(const char *, const char *, void *);
1908extern int git_config_from_file(config_fn_t fn, const char *, void *);
Vasco Almeida1b8132d2016-07-28 13:14:031909extern int git_config_from_mem(config_fn_t fn, const enum config_origin_type,
Lars Schneider473166b2016-02-19 09:16:011910 const char *name, const char *buf, size_t len, void *data);
Brandon Williams9ebf6892016-12-16 19:03:181911extern int git_config_from_blob_sha1(config_fn_t fn, const char *name,
1912 const unsigned char *sha1, void *data);
Jeff King2b64fc82010-08-23 19:16:001913extern void git_config_push_parameter(const char *text);
Thomas Rastb3d83d92010-05-21 10:07:471914extern int git_config_from_parameters(config_fn_t fn, void *data);
Johannes Schindelin0654aa52017-03-13 20:11:041915extern void read_early_config(config_fn_t cb, void *data);
Tanay Abhraaace4382014-08-07 11:59:151916extern void git_config(config_fn_t fn, void *);
Jeff King9b25a0b2012-02-06 09:54:041917extern int git_config_with_options(config_fn_t fn, void *,
Kirill A. Shutemovc8985ce2014-02-18 22:58:541918 struct git_config_source *config_source,
Nguyễn Thái Ngọc Duyc48f4b32017-04-17 10:10:001919 const struct config_options *opts);
Brian Downing0b87b6e2007-07-12 13:32:261920extern int git_parse_ulong(const char *, unsigned long *);
Dave Borowitz9a549d42015-08-19 15:26:441921extern int git_parse_maybe_bool(const char *);
Linus Torvalds17712992005-10-10 23:31:081922extern int git_config_int(const char *, const char *);
Jeff King00160242013-09-08 08:40:021923extern int64_t git_config_int64(const char *, const char *);
Brian Downing0b87b6e2007-07-12 13:32:261924extern unsigned long git_config_ulong(const char *, const char *);
David Turner37ee6802017-04-11 18:13:571925extern ssize_t git_config_ssize_t(const char *, const char *);
Junio C Hamanoa53f2ec2008-04-13 01:33:311926extern int git_config_bool_or_int(const char *, const char *, int *);
Linus Torvalds17712992005-10-10 23:31:081927extern int git_config_bool(const char *, const char *);
Junio C Hamano8420ccd2010-02-17 07:59:461928extern int git_config_maybe_bool(const char *, const char *);
Christian Couderea5105a2008-02-16 05:00:241929extern int git_config_string(const char **, const char *, const char *);
Matthieu Moy395de252009-11-17 17:24:251930extern int git_config_pathname(const char **, const char *, const char *);
Patrick Steinhardt30598ad2016-02-22 11:23:351931extern int git_config_set_in_file_gently(const char *, const char *, const char *);
Patrick Steinhardt3d180642016-02-22 11:23:361932extern void git_config_set_in_file(const char *, const char *, const char *);
Patrick Steinhardt30598ad2016-02-22 11:23:351933extern int git_config_set_gently(const char *, const char *);
Patrick Steinhardt3d180642016-02-22 11:23:361934extern void git_config_set(const char *, const char *);
Libor Pechacekb09c53a2011-01-30 19:40:411935extern int git_config_parse_key(const char *, char **, int *);
Jeff King9e9de182015-08-24 06:11:331936extern int git_config_key_is_valid(const char *key);
Patrick Steinhardt30598ad2016-02-22 11:23:351937extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);
Patrick Steinhardt3d180642016-02-22 11:23:361938extern void git_config_set_multivar(const char *, const char *, const char *, int);
Patrick Steinhardt30598ad2016-02-22 11:23:351939extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
Patrick Steinhardt3d180642016-02-22 11:23:361940extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
Johannes Schindelin0667fcf2006-12-16 14:14:141941extern int git_config_rename_section(const char *, const char *);
Jeff King42bd39b2012-02-16 08:04:251942extern int git_config_rename_section_in_file(const char *, const char *, const char *);
Johannes Sixt506b17b2007-11-13 20:05:051943extern const char *git_etc_gitconfig(void);
Lars R. Damerow0ef37162010-03-17 19:55:511944extern int git_env_bool(const char *, int);
Steffen Prohaska23b0c472014-08-26 15:23:211945extern unsigned long git_env_ulong(const char *, unsigned long);
Jeff Kingab88c362008-02-06 10:11:181946extern int git_config_system(void);
Junio C Hamano40ea4ed2008-02-11 18:41:181947extern int config_error_nonbool(const char *);
Jeff Kingff0a80a2014-05-06 15:17:501948#if defined(__GNUC__)
Jeff King87fe5df2014-05-06 15:14:421949#define config_error_nonbool(s) (config_error_nonbool(s), const_error())
Jeff Kinga469a102012-12-15 17:42:101950#endif
Pat Notza6fa5992010-11-02 19:59:071951extern const char *get_log_output_encoding(void);
1952extern const char *get_commit_output_encoding(void);
1953
Jeff King24968442011-06-09 15:56:421954extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
Jeff King9acc5912016-05-18 22:44:231955
1956enum config_scope {
1957 CONFIG_SCOPE_UNKNOWN = 0,
1958 CONFIG_SCOPE_SYSTEM,
1959 CONFIG_SCOPE_GLOBAL,
1960 CONFIG_SCOPE_REPO,
1961 CONFIG_SCOPE_CMDLINE,
1962};
1963
1964extern enum config_scope current_config_scope(void);
Lars Schneider473166b2016-02-19 09:16:011965extern const char *current_config_origin_type(void);
1966extern const char *current_config_name(void);
Jeff King24968442011-06-09 15:56:421967
Jeff King9b25a0b2012-02-06 09:54:041968struct config_include_data {
1969 int depth;
1970 config_fn_t fn;
1971 void *data;
Nguyễn Thái Ngọc Duyc48f4b32017-04-17 10:10:001972 const struct config_options *opts;
Jeff King9b25a0b2012-02-06 09:54:041973};
1974#define CONFIG_INCLUDE_INIT { 0 }
1975extern int git_config_include(const char *name, const char *value, void *data);
Linus Torvalds17712992005-10-10 23:31:081976
Jeff King1b86bbb2013-01-23 06:23:051977/*
1978 * Match and parse a config key of the form:
1979 *
1980 * section.(subsection.)?key
1981 *
1982 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1983 * we return -1 if it does not match, 0 otherwise. The subsection and key
Jeff King48f8d9f2017-02-24 21:08:021984 * out-parameters are filled by the function (and *subsection is NULL if it is
Jeff King1b86bbb2013-01-23 06:23:051985 * missing).
Jeff King48f8d9f2017-02-24 21:08:021986 *
1987 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if
1988 * there is no subsection at all.
Jeff King1b86bbb2013-01-23 06:23:051989 */
1990extern int parse_config_key(const char *var,
1991 const char *section,
1992 const char **subsection, int *subsection_len,
1993 const char **key);
1994
Tanay Abhra155ef252014-08-07 11:59:171995struct config_set_element {
1996 struct hashmap_entry ent;
1997 char *key;
1998 struct string_list value_list;
1999};
2000
2001struct configset_list_item {
2002 struct config_set_element *e;
2003 int value_index;
2004};
2005
2006/*
2007 * the contents of the list are ordered according to their
2008 * position in the config files and order of parsing the files.
2009 * (i.e. key-value pair at the last position of .git/config will
2010 * be at the last item of the list)
2011 */
2012struct configset_list {
2013 struct configset_list_item *items;
2014 unsigned int nr, alloc;
2015};
2016
Tanay Abhra3c8687a2014-07-28 10:10:382017struct config_set {
2018 struct hashmap config_hash;
2019 int hash_initialized;
Tanay Abhra155ef252014-08-07 11:59:172020 struct configset_list list;
Tanay Abhra3c8687a2014-07-28 10:10:382021};
2022
2023extern void git_configset_init(struct config_set *cs);
2024extern int git_configset_add_file(struct config_set *cs, const char *filename);
2025extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
2026extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
2027extern void git_configset_clear(struct config_set *cs);
2028extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
2029extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
2030extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
2031extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
2032extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
2033extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
2034extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
2035extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
2036
2037extern int git_config_get_value(const char *key, const char **value);
2038extern const struct string_list *git_config_get_value_multi(const char *key);
2039extern void git_config_clear(void);
2040extern void git_config_iter(config_fn_t fn, void *data);
2041extern int git_config_get_string_const(const char *key, const char **dest);
2042extern int git_config_get_string(const char *key, char **dest);
2043extern int git_config_get_int(const char *key, int *dest);
2044extern int git_config_get_ulong(const char *key, unsigned long *dest);
2045extern int git_config_get_bool(const char *key, int *dest);
2046extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
2047extern int git_config_get_maybe_bool(const char *key, int *dest);
2048extern int git_config_get_pathname(const char *key, const char **dest);
Christian Couder435ec092016-01-27 06:58:052049extern int git_config_get_untracked_cache(void);
Christian Couder1f44b092017-02-27 18:00:002050extern int git_config_get_split_index(void);
Christian Couder72dcb7b2017-02-27 18:00:072051extern int git_config_get_max_percent_split_change(void);
Tanay Abhra3c8687a2014-07-28 10:10:382052
Christian Couder77d67972017-02-27 18:00:132053/* This dies if the configured or default date is in the future */
2054extern int git_config_get_expiry(const char *key, const char **output);
Tanay Abhra3c8687a2014-07-28 10:10:382055
Christian Couderdae6c322016-01-27 06:58:062056/*
2057 * This is a hack for test programs like test-dump-untracked-cache to
2058 * ensure that they do not modify the untracked cache when reading it.
2059 * Do not use it otherwise!
2060 */
2061extern int ignore_untracked_cache_config;
Matthias Lederhoferaa086eb2006-07-29 22:27:432062
Tanay Abhra3df8fd62014-08-07 11:59:142063struct key_value_info {
2064 const char *filename;
2065 int linenr;
Vasco Almeida1b8132d2016-07-28 13:14:032066 enum config_origin_type origin_type;
Jeff King9acc5912016-05-18 22:44:232067 enum config_scope scope;
Tanay Abhra3df8fd62014-08-07 11:59:142068};
2069
Tanay Abhra5a80e972014-08-07 11:59:162070extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
2071extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
2072
Jeff Kingd6991ce2012-11-15 00:34:132073extern int committer_ident_sufficiently_given(void);
Linus Torvaldse1b10392005-10-12 01:47:342074extern int author_ident_sufficiently_given(void);
Shawn O. Pearce1a8f2742007-03-12 19:33:182075
Shawn O. Pearce3a556022007-03-07 01:44:172076extern const char *git_commit_encoding;
Marius Storm-Olsend551a482009-02-08 14:34:272077extern const char *git_log_output_encoding;
Junio C Hamano4e72dce2005-11-28 00:09:402078extern const char *git_mailmap_file;
Theodore Ts'o06f59e92007-06-29 17:40:462079extern const char *git_mailmap_blob;
2080
Junio C Hamanof3123c42005-10-22 08:28:132081/* IO helper functions */
Daniel Barkalow1468bd42008-02-25 19:24:482082extern void maybe_flush_or_die(FILE *, const char *);
Jeff King9540ce52014-09-10 10:03:522083__attribute__((format (printf, 2, 3)))
2084extern void fprintf_or_die(FILE *, const char *fmt, ...);
Junio C Hamano00b7cbf2015-05-19 17:55:162085
2086#define COPY_READ_ERROR (-2)
2087#define COPY_WRITE_ERROR (-3)
Daniel Barkalow1468bd42008-02-25 19:24:482088extern int copy_fd(int ifd, int ofd);
Clemens Buchacherf7835a22009-09-12 09:03:482089extern int copy_file(const char *dst, const char *src, int mode);
Rene Scharfe7230e6d2006-08-21 18:43:432090extern int copy_file_with_time(const char *dst, const char *src, int mode);
Junio C Hamano00b7cbf2015-05-19 17:55:162091
Christian Couder6ce4e612006-09-02 16:23:482092extern void write_or_die(int fd, const void *buf, size_t count);
Junio C Hamanoad897212005-12-15 06:17:382093extern void fsync_or_die(int fd, const char *);
Jim Meyering2b7ca832009-09-12 08:54:322094
2095extern ssize_t read_in_full(int fd, void *buf, size_t count);
2096extern ssize_t write_in_full(int fd, const void *buf, size_t count);
2097extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
2098
2099static inline ssize_t write_str_in_full(int fd, const char *str)
2100{
Linus Torvaldsf67b45f2006-02-28 19:26:212101 return write_in_full(fd, str, strlen(str));
2102}
Junio C Hamano12d6ce12015-08-24 20:03:072103
Jeff King52563d72016-07-08 09:12:222104/**
2105 * Open (and truncate) the file at path, write the contents of buf to it,
2106 * and close it. Dies if any errors are encountered.
2107 */
2108extern void write_file_buf(const char *path, const char *buf, size_t len);
2109
Jeff Kinge04d08a2016-07-08 09:12:422110/**
2111 * Like write_file_buf(), but format the contents into a buffer first.
2112 * Additionally, write_file() will append a newline if one is not already
2113 * present, making it convenient to write text files:
2114 *
2115 * write_file(path, "counter: %d", ctr);
2116 */
2117__attribute__((format (printf, 2, 3)))
Jeff Kingef223182016-07-08 09:09:342118extern void write_file(const char *path, const char *fmt, ...);
Jim Meyering2b7ca832009-09-12 08:54:322119
Linus Torvaldsf67b45f2006-02-28 19:26:212120/* pager.c */
2121extern void setup_pager(void);
Jeff King6e9af862007-12-11 06:27:332122extern int pager_in_use(void);
Matthias Lederhoferaa086eb2006-07-29 22:27:432123extern int pager_use_color;
Zbigniew Jędrzejewski-Szmekad6c3732012-02-12 14:12:322124extern int term_columns(void);
Jeff Kingd306f3d2015-02-05 08:14:192125extern int decimal_width(uintmax_t);
Nguyễn Thái Ngọc Duy4914c962012-10-26 15:53:522126extern int check_pager_config(const char *cmd);
Junio C Hamano3e3a4a42016-02-16 22:34:442127extern void prepare_pager_args(struct child_process *, const char *pager);
Linus Torvaldsf67b45f2006-02-28 19:26:212128
Christian Couderee9601e2008-02-16 05:01:412129extern const char *editor_program;
Anselm Kruisd3e7da82010-08-30 13:38:382130extern const char *askpass_program;
Christian Couderdfb068b2008-02-16 05:01:592131extern const char *excludes_file;
Johannes Schindelin4d87b9c2007-07-20 12:06:092132
Junio C Hamano051308f2006-05-04 23:51:442133/* base85 */
Jim Meyeringf9815772007-04-09 22:56:332134int decode_85(char *dst, const char *line, int linelen);
2135void encode_85(char *buf, const unsigned char *data, int bytes);
Junio C Hamano051308f2006-05-04 23:51:442136
Linus Torvalds855419f2006-06-19 17:44:152137/* alloc.c */
Linus Torvalds100c5f32007-04-17 05:11:432138extern void *alloc_blob_node(void);
2139extern void *alloc_tree_node(void);
2140extern void *alloc_commit_node(void);
2141extern void *alloc_tag_node(void);
2142extern void *alloc_object_node(void);
Linus Torvalds855419f2006-06-19 17:44:152143extern void alloc_report(void);
Jeff King94d5a222014-07-13 06:42:082144extern unsigned int alloc_commit_index(void);
Linus Torvalds855419f2006-06-19 17:44:152145
Karsten Blees5991a552014-06-11 07:56:492146/* pkt-line.c */
Jeff Kingbbc30f92011-02-24 14:30:192147void packet_trace_identity(const char *prog);
Christian Couder6ce4e612006-09-02 16:23:482148
Junio C Hamanob6ec1d62007-11-18 09:12:042149/* add */
Alex Riesen7ae02a32008-05-12 17:58:102150/*
2151 * return 0 if success, 1 - if addition of a file failed and
2152 * ADD_FILES_IGNORE_ERRORS was specified in flags
2153 */
Thomas Gummerer610d55a2016-09-14 21:07:472154int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
Junio C Hamanob6ec1d62007-11-18 09:12:042155
Junio C Hamanoaecbf912007-08-31 20:13:422156/* diff.c */
2157extern int diff_auto_refresh_index;
2158
Junio C Hamano68faf682007-02-16 00:32:452159/* match-trees.c */
brian m. carlson82db3d42016-04-17 23:10:382160void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);
2161void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);
Junio C Hamano68faf682007-02-16 00:32:452162
Junio C Hamanoa9cc8572007-11-02 07:24:272163/*
2164 * whitespace rules.
2165 * used by both diff and apply
Johannes Sixtf4b05a42010-11-30 08:29:112166 * last two digits are tab width
Junio C Hamanoa9cc8572007-11-02 07:24:272167 */
Johannes Sixtf4b05a42010-11-30 08:29:112168#define WS_BLANK_AT_EOL 0100
2169#define WS_SPACE_BEFORE_TAB 0200
2170#define WS_INDENT_WITH_NON_TAB 0400
2171#define WS_CR_AT_EOL 01000
2172#define WS_BLANK_AT_EOF 02000
2173#define WS_TAB_IN_INDENT 04000
Junio C Hamanoaeb84b02009-09-06 05:21:172174#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
Johannes Sixtf4b05a42010-11-30 08:29:112175#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
2176#define WS_TAB_WIDTH_MASK 077
Junio C Hamanocf1b7862007-12-06 08:14:142177extern unsigned whitespace_rule_cfg;
2178extern unsigned whitespace_rule(const char *);
2179extern unsigned parse_whitespace_rule(const char *);
Junio C Hamano8f8841e2008-06-26 22:35:212180extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
2181extern 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:292182extern char *whitespace_error_string(unsigned ws);
Chris Webbd511bd32010-04-02 23:37:232183extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
Junio C Hamano877f23c2008-06-26 22:36:592184extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
Johannes Sixtf4b05a42010-11-30 08:29:112185#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
Junio C Hamanoa9cc8572007-11-02 07:24:272186
Junio C Hamanoee425e42007-11-18 09:13:322187/* ls-files */
Junio C Hamanoee425e42007-11-18 09:13:322188void overlay_tree_on_cache(const char *tree_name, const char *prefix);
2189
Jeff King94351112008-02-24 22:17:142190char *alias_lookup(const char *alias);
Miklos Vajna0989fe92008-06-27 16:21:542191int split_cmdline(char *cmdline, const char ***argv);
Greg Brockmanad9ac6d2010-08-07 05:13:392192/* Takes a negative value returned by split_cmdline */
2193const char *split_cmdline_strerror(int cmdline_errno);
Jeff King94351112008-02-24 22:17:142194
Jeff King46c3cd42016-03-05 22:10:272195/* setup.c */
Nguyễn Thái Ngọc Duye37c1322010-08-06 02:40:352196struct startup_info {
Nguyễn Thái Ngọc Duya60645f2010-08-06 02:46:332197 int have_repository;
Nguyễn Thái Ngọc Duyf07d6a12010-12-01 23:33:222198 const char *prefix;
Nguyễn Thái Ngọc Duye37c1322010-08-06 02:40:352199};
2200extern struct startup_info *startup_info;
2201
Nguyễn Thái Ngọc Duydb699a82012-10-26 15:53:492202/* merge.c */
2203struct commit_list;
2204int try_merge_command(const char *strategy, size_t xopts_nr,
2205 const char **xopts, struct commit_list *common,
2206 const char *head_arg, struct commit_list *remotes);
2207int checkout_fast_forward(const unsigned char *from,
2208 const unsigned char *to,
2209 int overwrite_ignore);
2210
Junio C Hamanocac42b22010-03-06 20:34:412211
Jeff King38f865c2012-03-30 07:52:182212int sane_execvp(const char *file, char *const argv[]);
2213
Michael Haggerty38612532013-06-20 08:37:512214/*
2215 * A struct to encapsulate the concept of whether a file has changed
2216 * since we last checked it. This uses criteria similar to those used
2217 * for the index.
2218 */
2219struct stat_validity {
2220 struct stat_data *sd;
2221};
2222
2223void stat_validity_clear(struct stat_validity *sv);
2224
2225/*
2226 * Returns 1 if the path is a regular file (or a symlink to a regular
2227 * file) and matches the saved stat_validity, 0 otherwise. A missing
2228 * or inaccessible file is considered a match if the struct was just
2229 * initialized, or if the previous update found an inaccessible file.
2230 */
2231int stat_validity_check(struct stat_validity *sv, const char *path);
2232
2233/*
2234 * Update the stat_validity from a file opened at descriptor fd. If
2235 * the file is missing, inaccessible, or not a regular file, then
2236 * future calls to stat_validity_check will match iff one of those
2237 * conditions continues to be true.
2238 */
2239void stat_validity_update(struct stat_validity *sv, int fd);
2240
Nguyễn Thái Ngọc Duy9ef176b2014-02-27 12:56:522241int versioncmp(const char *s1, const char *s2);
Johannes Sixt2024d312015-06-05 19:45:052242void sleep_millisec(int millisec);
Nguyễn Thái Ngọc Duy9ef176b2014-02-27 12:56:522243
David Turnereb338762015-11-10 11:42:382244/*
2245 * Create a directory and (if share is nonzero) adjust its permissions
2246 * according to the shared_repository setting. Only use this for
2247 * directories under $GIT_DIR. Don't use it for working tree
2248 * directories.
2249 */
2250void safe_create_dir(const char *dir, int share);
2251
Linus Torvaldse83c5162005-04-07 22:13:132252#endif /* CACHE_H */