🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.20.2 / . / cache.h
blob: ca36b44ee0b5851f837616c322a201ac420a90d2 [file] [log] [blame]
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]1#ifndef CACHE_H
2#define CACHE_H
3
Junio C Hamano4050c0d2005-12-05 19:54:29[diff] [blame]4#include "git-compat-util.h"
Pierre Habouzit5ecd2932007-09-16 13:51:04[diff] [blame]5#include "strbuf.h"
Karsten Bleese05881a2013-11-14 19:20:58[diff] [blame]6#include "hashmap.h"
Gargi Sharmaec2dd322018-01-23 23:46:51[diff] [blame]7#include "list.h"
Jeff King75194432009-09-09 11:38:58[diff] [blame]8#include "advice.h"
Ævar Arnfjör�� Bjarmason65784832011-02-22 23:41:20[diff] [blame]9#include "gettext.h"
Junio C Hamanod1bf0e02011-05-20 19:59:01[diff] [blame]10#include "convert.h"
Karsten Blees5991a552014-06-11 07:56:49[diff] [blame]11#include "trace.h"
Tanay Abhra155ef252014-08-07 11:59:17[diff] [blame]12#include "string-list.h"
Jeff Kingf4015332015-12-21 06:19:49[diff] [blame]13#include "pack-revindex.h"
brian m. carlsonf18f8162017-03-11 22:28:18[diff] [blame]14#include "hash.h"
Brandon Williamse7d72d02017-06-22 18:43:35[diff] [blame]15#include "path.h"
René Scharfecc817ca2017-06-22 18:19:48[diff] [blame]16#include "sha1-array.h"
brian m. carlson78a67662017-11-12 21:28:53[diff] [blame]17#include "repository.h"
Jameson Miller8e72d672018-07-02 19:49:37[diff] [blame]18#include "mem-pool.h"
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]19
Nicolas Pitre9126f002008-10-01 18:05:20[diff] [blame]20#include <zlib.h>
Junio C Hamanoef49a7a2011-06-10 18:52:15[diff] [blame]21typedef struct git_zstream {
22 z_stream z;
23 unsigned long avail_in;
24 unsigned long avail_out;
25 unsigned long total_in;
26 unsigned long total_out;
27 unsigned char *next_in;
28 unsigned char *next_out;
29} git_zstream;
Edgar Toernig9da3acf2005-04-30 16:51:03[diff] [blame]30
Junio C Hamanoef49a7a2011-06-10 18:52:15[diff] [blame]31void git_inflate_init(git_zstream *);
32void git_inflate_init_gzip_only(git_zstream *);
33void git_inflate_end(git_zstream *);
34int git_inflate(git_zstream *, int flush);
Linus Torvalds39c68542009-01-08 03:54:47[diff] [blame]35
Junio C Hamanoef49a7a2011-06-10 18:52:15[diff] [blame]36void git_deflate_init(git_zstream *, int level);
37void git_deflate_init_gzip(git_zstream *, int level);
René Scharfec3c2e1a2013-03-15 22:21:51[diff] [blame]38void git_deflate_init_raw(git_zstream *, int level);
Junio C Hamanoef49a7a2011-06-10 18:52:15[diff] [blame]39void git_deflate_end(git_zstream *);
Junio C Hamano568508e2011-10-28 21:48:40[diff] [blame]40int git_deflate_abort(git_zstream *);
Junio C Hamanoef49a7a2011-06-10 18:52:15[diff] [blame]41int git_deflate_end_gently(git_zstream *);
42int git_deflate(git_zstream *, int flush);
43unsigned long git_deflate_bound(git_zstream *, unsigned long);
Linus Torvalds39c68542009-01-08 03:54:47[diff] [blame]44
brian m. carlson5f7817c2015-03-13 23:39:27[diff] [blame]45/* The length in bytes and in hex digits of an object name (SHA-1 value). */
46#define GIT_SHA1_RAWSZ 20
47#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
48
brian m. carlson5028bf62017-03-26 16:01:23[diff] [blame]49/* The length in byte and in hex digits of the largest possible hash value. */
50#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ
51#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ
52
brian m. carlson5f7817c2015-03-13 23:39:27[diff] [blame]53struct object_id {
brian m. carlson5028bf62017-03-26 16:01:23[diff] [blame]54 unsigned char hash[GIT_MAX_RAWSZ];
brian m. carlson5f7817c2015-03-13 23:39:27[diff] [blame]55};
56
brian m. carlson78a67662017-11-12 21:28:53[diff] [blame]57#define the_hash_algo the_repository->hash_algo
58
Timo Hirvonen962554c2006-02-26 15:13:46[diff] [blame]59#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
Edgar Toernigb6829692005-04-30 16:51:03[diff] [blame]60#define DTYPE(de) ((de)->d_type)
61#else
Junio C Hamano0bdd79a2006-01-20 21:33:20[diff] [blame]62#undef DT_UNKNOWN
63#undef DT_DIR
64#undef DT_REG
65#undef DT_LNK
Edgar Toernigb6829692005-04-30 16:51:03[diff] [blame]66#define DT_UNKNOWN 0
67#define DT_DIR 1
68#define DT_REG 2
Junio C Hamanoa15c1c62005-05-13 00:16:04[diff] [blame]69#define DT_LNK 3
Edgar Toernigb6829692005-04-30 16:51:03[diff] [blame]70#define DTYPE(de) DT_UNKNOWN
71#endif
72
Martin Koegler40689ae2007-04-22 16:43:56[diff] [blame]73/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
74#define S_IFINVALID 0030000
75
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]76/*
Linus Torvalds9eec4792007-04-10 04:14:58[diff] [blame]77 * A "directory link" is a link to another git directory.
78 *
79 * The value 0160000 is not normally a valid mode, and
80 * also just happens to be S_IFDIR + S_IFLNK
Linus Torvalds9eec4792007-04-10 04:14:58[diff] [blame]81 */
Martin Waitz302b9282007-05-21 20:08:28[diff] [blame]82#define S_IFGITLINK 0160000
83#define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
Linus Torvalds9eec4792007-04-10 04:14:58[diff] [blame]84
85/*
Kirill Smelkov72441af2014-04-06 21:46:26[diff] [blame]86 * Some mode bits are also used internally for computations.
87 *
88 * They *must* not overlap with any valid modes, and they *must* not be emitted
89 * to outside world - i.e. appear on disk or network. In other words, it's just
90 * temporary fields, which we internally use, but they have to stay in-house.
91 *
92 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
93 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
94 */
95
96/* used internally in tree-diff */
97#define S_DIFFTREE_IFXMIN_NEQ 0x80000000
98
99
100/*
Linus Torvalds2386d652005-07-14 01:46:20[diff] [blame]101 * Intensive research over the course of many years has shown that
102 * port 9418 is totally unused by anything else. Or
103 *
104 * Your search - "port 9418" - did not match any documents.
105 *
106 * as www.google.com puts it.
Linus Torvaldsba8a4972005-09-12 18:23:00[diff] [blame]107 *
108 * This port has been properly assigned for git use by IANA:
109 * git (Assigned-9418) [I06-050728-0001].
110 *
111 * git 9418/tcp git pack transfer service
112 * git 9418/udp git pack transfer service
113 *
114 * with Linus Torvalds <torvalds@osdl.org> as the point of
115 * contact. September 2005.
116 *
117 * See http://www.iana.org/assignments/port-numbers
Linus Torvalds2386d652005-07-14 01:46:20[diff] [blame]118 */
119#define DEFAULT_GIT_PORT 9418
120
121/*
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]122 * Basic data structures for the directory cache
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]123 */
124
125#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
126struct cache_header {
Thomas Gummerer7800c1e2013-08-18 19:41:51[diff] [blame]127 uint32_t hdr_signature;
128 uint32_t hdr_version;
129 uint32_t hdr_entries;
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]130};
131
Junio C Hamano9d227782012-04-04 16:12:43[diff] [blame]132#define INDEX_FORMAT_LB 2
133#define INDEX_FORMAT_UB 4
134
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]135/*
136 * The "cache_time" is just the low 32 bits of the
137 * time. It doesn't matter if it overflows - we only
138 * check it for equality in the 32 bits we save.
139 */
140struct cache_time {
Thomas Gummerer7800c1e2013-08-18 19:41:51[diff] [blame]141 uint32_t sec;
142 uint32_t nsec;
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]143};
144
Michael Haggertyc21d39d2013-06-20 08:37:50[diff] [blame]145struct stat_data {
146 struct cache_time sd_ctime;
147 struct cache_time sd_mtime;
148 unsigned int sd_dev;
149 unsigned int sd_ino;
150 unsigned int sd_uid;
151 unsigned int sd_gid;
152 unsigned int sd_size;
153};
154
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]155struct cache_entry {
Karsten Blees8b013782013-11-14 19:21:58[diff] [blame]156 struct hashmap_entry ent;
Michael Haggertyc21d39d2013-06-20 08:37:50[diff] [blame]157 struct stat_data ce_stat_data;
Linus Torvaldsccc4feb2005-04-15 17:44:27[diff] [blame]158 unsigned int ce_mode;
Linus Torvalds7a51ed62008-01-15 00:03:17[diff] [blame]159 unsigned int ce_flags;
Jameson Miller8e72d672018-07-02 19:49:37[diff] [blame]160 unsigned int mem_pool_allocated;
Thomas Gummererb60e1882012-07-11 09:22:37[diff] [blame]161 unsigned int ce_namelen;
Nguyễn Thái Ngọc Duy5fc2fc82014-06-13 12:19:36[diff] [blame]162 unsigned int index; /* for link extension */
brian m. carlson99d1a982016-09-05 20:07:52[diff] [blame]163 struct object_id oid;
Junio C Hamano8f1d2e62006-01-07 09:33:54[diff] [blame]164 char name[FLEX_ARRAY]; /* more */
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]165};
166
Linus Torvalds95fd5bf2005-04-16 05:51:44[diff] [blame]167#define CE_STAGEMASK (0x3000)
Junio C Hamano16ce2e4c2008-08-17 06:02:08[diff] [blame]168#define CE_EXTENDED (0x4000)
Junio C Hamano5f730762006-02-09 05:15:24[diff] [blame]169#define CE_VALID (0x8000)
Junio C Hamanoaee46192005-04-16 15:33:23[diff] [blame]170#define CE_STAGESHIFT 12
Linus Torvalds95fd5bf2005-04-16 05:51:44[diff] [blame]171
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01[diff] [blame]172/*
Nguyễn Thái Ngọc Duyce51bf02014-06-13 12:19:25[diff] [blame]173 * Range 0xFFFF0FFF in ce_flags is divided into
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01[diff] [blame]174 * two parts: in-memory flags and on-disk ones.
175 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
176 * if you want to save a new flag, add it in
177 * CE_EXTENDED_FLAGS
178 *
179 * In-memory only flags
180 */
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16[diff] [blame]181#define CE_UPDATE (1 << 16)
182#define CE_REMOVE (1 << 17)
183#define CE_UPTODATE (1 << 18)
184#define CE_ADDED (1 << 19)
Linus Torvaldsa22c6372008-02-23 04:37:40[diff] [blame]185
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16[diff] [blame]186#define CE_HASHED (1 << 20)
Ben Peart883e2482017-09-22 16:35:40[diff] [blame]187#define CE_FSMONITOR_VALID (1 << 21)
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16[diff] [blame]188#define CE_WT_REMOVE (1 << 22) /* remove in work directory */
189#define CE_CONFLICTED (1 << 23)
Linus Torvalds7a51ed62008-01-15 00:03:17[diff] [blame]190
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16[diff] [blame]191#define CE_UNPACKED (1 << 24)
Nguyễn Thái Ngọc Duy2431afb2010-11-27 06:24:04[diff] [blame]192#define CE_NEW_SKIP_WORKTREE (1 << 25)
Junio C Hamanoda165f42010-01-07 22:59:54[diff] [blame]193
Nguyễn Thái Ngọc Duye721c152013-03-27 05:58:21[diff] [blame]194/* used to temporarily mark paths matched by pathspecs */
195#define CE_MATCHED (1 << 26)
196
Nguyễn Thái Ngọc Duy078a58e2014-06-13 12:19:39[diff] [blame]197#define CE_UPDATE_IN_BASE (1 << 27)
Nguyễn Thái Ngọc Duyb3c96fb2014-06-13 12:19:43[diff] [blame]198#define CE_STRIP_NAME (1 << 28)
Nguyễn Thái Ngọc Duy078a58e2014-06-13 12:19:39[diff] [blame]199
Linus Torvaldsd070e3a2008-02-23 04:39:21[diff] [blame]200/*
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01[diff] [blame]201 * Extended on-disk flags
202 */
Nguyễn Thái Ngọc Duy2977ffb2010-11-27 06:22:16[diff] [blame]203#define CE_INTENT_TO_ADD (1 << 29)
204#define CE_SKIP_WORKTREE (1 << 30)
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01[diff] [blame]205/* CE_EXTENDED2 is for future extension */
Jeff King9a93c662015-12-29 06:35:46[diff] [blame]206#define CE_EXTENDED2 (1U << 31)
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01[diff] [blame]207
Nguyễn Thái Ngọc Duy44a36912009-08-20 13:46:57[diff] [blame]208#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01[diff] [blame]209
210/*
211 * Safeguard to avoid saving wrong flags:
212 * - CE_EXTENDED2 won't get saved until its semantic is known
213 * - Bits in 0x0000FFFF have been saved in ce_flags already
214 * - Bits in 0x003F0000 are currently in-memory flags
215 */
216#if CE_EXTENDED_FLAGS & 0x803FFFFF
217#error "CE_EXTENDED_FLAGS out of range"
218#endif
219
Junio C Hamano3e3a4a42016-02-16 22:34:44[diff] [blame]220/* Forward structure decls */
Nguyễn Thái Ngọc Duy64acde92013-07-14 08:35:25[diff] [blame]221struct pathspec;
Junio C Hamano3e3a4a42016-02-16 22:34:44[diff] [blame]222struct child_process;
Elijah Newrene1f86942018-07-01 01:25:00[diff] [blame]223struct tree;
Nguyễn Thái Ngọc Duy64acde92013-07-14 08:35:25[diff] [blame]224
Nguyễn Thái Ngọc Duy06aaaa02008-10-01 04:04:01[diff] [blame]225/*
Linus Torvaldseb7a2f12008-02-23 04:41:17[diff] [blame]226 * Copy the sha1 and stat state of a cache entry from one to
227 * another. But we never change the name, or the hash state!
228 */
René Scharfe20d142b2013-06-02 15:46:51[diff] [blame]229static inline void copy_cache_entry(struct cache_entry *dst,
230 const struct cache_entry *src)
Linus Torvaldseb7a2f12008-02-23 04:41:17[diff] [blame]231{
Karsten Blees419a5972013-11-14 19:22:27[diff] [blame]232 unsigned int state = dst->ce_flags & CE_HASHED;
Jameson Miller8e72d672018-07-02 19:49:37[diff] [blame]233 int mem_pool_allocated = dst->mem_pool_allocated;
Linus Torvaldseb7a2f12008-02-23 04:41:17[diff] [blame]234
235 /* Don't copy hash chain and name */
Karsten Blees8b013782013-11-14 19:21:58[diff] [blame]236 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
237 offsetof(struct cache_entry, name) -
238 offsetof(struct cache_entry, ce_stat_data));
Linus Torvaldseb7a2f12008-02-23 04:41:17[diff] [blame]239
240 /* Restore the hash state */
Karsten Blees419a5972013-11-14 19:22:27[diff] [blame]241 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
Jameson Miller8e72d672018-07-02 19:49:37[diff] [blame]242
243 /* Restore the mem_pool_allocated flag */
244 dst->mem_pool_allocated = mem_pool_allocated;
Linus Torvaldseb7a2f12008-02-23 04:41:17[diff] [blame]245}
246
Thomas Gummererb60e1882012-07-11 09:22:37[diff] [blame]247static inline unsigned create_ce_flags(unsigned stage)
Junio C Hamano7fec10b2008-01-19 07:42:00[diff] [blame]248{
Thomas Gummererb60e1882012-07-11 09:22:37[diff] [blame]249 return (stage << CE_STAGESHIFT);
Junio C Hamano7fec10b2008-01-19 07:42:00[diff] [blame]250}
251
Thomas Gummererb60e1882012-07-11 09:22:37[diff] [blame]252#define ce_namelen(ce) ((ce)->ce_namelen)
Junio C Hamanoaee46192005-04-16 15:33:23[diff] [blame]253#define ce_size(ce) cache_entry_size(ce_namelen(ce))
Linus Torvalds7a51ed62008-01-15 00:03:17[diff] [blame]254#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
Junio C Hamanoeadb5832008-01-19 07:45:24[diff] [blame]255#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
Nguyễn Thái Ngọc Duy44a36912009-08-20 13:46:57[diff] [blame]256#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
Junio C Hamanoeadb5832008-01-19 07:45:24[diff] [blame]257#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
Nguyễn Thái Ngọc Duy895ff3b2015-08-22 01:08:05[diff] [blame]258#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
Junio C Hamanoaee46192005-04-16 15:33:23[diff] [blame]259
Linus Torvaldse4479472005-04-17 05:26:31[diff] [blame]260#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
Kay Sievers8ae0a8c2005-05-05 12:38:25[diff] [blame]261static inline unsigned int create_ce_mode(unsigned int mode)
262{
Kay Sievers8ae0a8c2005-05-05 12:38:25[diff] [blame]263 if (S_ISLNK(mode))
Linus Torvalds7a51ed62008-01-15 00:03:17[diff] [blame]264 return S_IFLNK;
Martin Waitz302b9282007-05-21 20:08:28[diff] [blame]265 if (S_ISDIR(mode) || S_ISGITLINK(mode))
Linus Torvalds7a51ed62008-01-15 00:03:17[diff] [blame]266 return S_IFGITLINK;
267 return S_IFREG | ce_permissions(mode);
Kay Sievers8ae0a8c2005-05-05 12:38:25[diff] [blame]268}
René Scharfe20d142b2013-06-02 15:46:51[diff] [blame]269static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
270 unsigned int mode)
Junio C Hamano185c9752007-02-17 06:43:48[diff] [blame]271{
Johannes Sixt78a8d642007-03-02 21:11:30[diff] [blame]272 extern int trust_executable_bit, has_symlinks;
273 if (!has_symlinks && S_ISREG(mode) &&
Linus Torvalds7a51ed62008-01-15 00:03:17[diff] [blame]274 ce && S_ISLNK(ce->ce_mode))
Johannes Sixt78a8d642007-03-02 21:11:30[diff] [blame]275 return ce->ce_mode;
Junio C Hamano185c9752007-02-17 06:43:48[diff] [blame]276 if (!trust_executable_bit && S_ISREG(mode)) {
Linus Torvalds7a51ed62008-01-15 00:03:17[diff] [blame]277 if (ce && S_ISREG(ce->ce_mode))
Junio C Hamano185c9752007-02-17 06:43:48[diff] [blame]278 return ce->ce_mode;
279 return create_ce_mode(0666);
280 }
281 return create_ce_mode(mode);
282}
Junio C Hamanod6b8fc32008-01-31 09:17:48[diff] [blame]283static inline int ce_to_dtype(const struct cache_entry *ce)
284{
285 unsigned ce_mode = ntohl(ce->ce_mode);
286 if (S_ISREG(ce_mode))
287 return DT_REG;
288 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
289 return DT_DIR;
290 else if (S_ISLNK(ce_mode))
291 return DT_LNK;
292 else
293 return DT_UNKNOWN;
294}
René Scharfeb90d9b82010-10-04 10:53:11[diff] [blame]295static inline unsigned int canon_mode(unsigned int mode)
296{
297 if (S_ISREG(mode))
298 return S_IFREG | ce_permissions(mode);
299 if (S_ISLNK(mode))
300 return S_IFLNK;
301 if (S_ISDIR(mode))
302 return S_IFDIR;
303 return S_IFGITLINK;
304}
Linus Torvaldse4479472005-04-17 05:26:31[diff] [blame]305
René Scharfeee7825b2011-10-25 18:00:04[diff] [blame]306#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
Linus Torvaldsf5cabd12005-04-16 04:45:38[diff] [blame]307
Nguyễn Thái Ngọc Duye636a7b2014-06-13 12:19:27[diff] [blame]308#define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
309#define CE_ENTRY_CHANGED (1 << 1)
310#define CE_ENTRY_REMOVED (1 << 2)
311#define CE_ENTRY_ADDED (1 << 3)
Nguyễn Thái Ngọc Duy6c306a32014-06-13 12:19:29[diff] [blame]312#define RESOLVE_UNDO_CHANGED (1 << 4)
Nguyễn Thái Ngọc Duya5400ef2014-06-13 12:19:31[diff] [blame]313#define CACHE_TREE_CHANGED (1 << 5)
Nguyễn Thái Ngọc Duyc18b80a2014-06-13 12:19:44[diff] [blame]314#define SPLIT_INDEX_ORDERED (1 << 6)
Nguyễn Thái Ngọc Duy1bbb3db2015-03-08 10:12:39[diff] [blame]315#define UNTRACKED_CHANGED (1 << 7)
Ben Peart883e2482017-09-22 16:35:40[diff] [blame]316#define FSMONITOR_CHANGED (1 << 8)
Nguyễn Thái Ngọc Duye636a7b2014-06-13 12:19:27[diff] [blame]317
Nguyễn Thái Ngọc Duy5fc2fc82014-06-13 12:19:36[diff] [blame]318struct split_index;
Nguyễn Thái Ngọc Duy83c094a2015-03-08 10:12:33[diff] [blame]319struct untracked_cache;
320
Junio C Hamano228e94f2007-04-02 01:14:06[diff] [blame]321struct index_state {
322 struct cache_entry **cache;
Junio C Hamano9d227782012-04-04 16:12:43[diff] [blame]323 unsigned int version;
Junio C Hamano228e94f2007-04-02 01:14:06[diff] [blame]324 unsigned int cache_nr, cache_alloc, cache_changed;
Junio C Hamanocfc57892009-12-25 08:30:51[diff] [blame]325 struct string_list *resolve_undo;
Junio C Hamano228e94f2007-04-02 01:14:06[diff] [blame]326 struct cache_tree *cache_tree;
Nguyễn Thái Ngọc Duy5fc2fc82014-06-13 12:19:36[diff] [blame]327 struct split_index *split_index;
Kjetil Barvikfba2f382009-02-19 20:08:29[diff] [blame]328 struct cache_time timestamp;
Junio C Hamano913e0e92008-08-23 19:57:30[diff] [blame]329 unsigned name_hash_initialized : 1,
Thomas Gummerer4bddd982018-01-07 22:30:14[diff] [blame]330 initialized : 1,
331 drop_cache_tree : 1;
Karsten Blees8b013782013-11-14 19:21:58[diff] [blame]332 struct hashmap name_hash;
Karsten Bleese05881a2013-11-14 19:20:58[diff] [blame]333 struct hashmap dir_hash;
brian m. carlson75691ea2018-05-02 00:25:44[diff] [blame]334 struct object_id oid;
Nguyễn Thái Ngọc Duy83c094a2015-03-08 10:12:33[diff] [blame]335 struct untracked_cache *untracked;
Ben Peart883e2482017-09-22 16:35:40[diff] [blame]336 uint64_t fsmonitor_last_update;
Alex Vandiverba1b9ca2017-10-27 23:26:37[diff] [blame]337 struct ewah_bitmap *fsmonitor_dirty;
Jameson Miller8e72d672018-07-02 19:49:37[diff] [blame]338 struct mem_pool *ce_mem_pool;
Junio C Hamano228e94f2007-04-02 01:14:06[diff] [blame]339};
340
341extern struct index_state the_index;
342
Linus Torvalds96872bc2008-03-21 20:16:24[diff] [blame]343/* Name hashing */
Jeff Hostetlerea194892017-03-23 13:47:04[diff] [blame]344extern int test_lazy_init_name_hash(struct index_state *istate, int try_threaded);
Linus Torvalds96872bc2008-03-21 20:16:24[diff] [blame]345extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
Karsten Blees20926782013-02-27 23:57:48[diff] [blame]346extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
347extern void free_name_hash(struct index_state *istate);
Linus Torvalds96872bc2008-03-21 20:16:24[diff] [blame]348
349
Jameson Millera8497352018-07-02 19:49:31[diff] [blame]350/* Cache entry creation and cleanup */
351
352/*
353 * Create cache_entry intended for use in the specified index. Caller
354 * is responsible for discarding the cache_entry with
355 * `discard_cache_entry`.
356 */
357struct cache_entry *make_cache_entry(struct index_state *istate,
358 unsigned int mode,
359 const struct object_id *oid,
360 const char *path,
361 int stage,
362 unsigned int refresh_options);
363
364struct cache_entry *make_empty_cache_entry(struct index_state *istate,
365 size_t name_len);
366
367/*
368 * Create a cache_entry that is not intended to be added to an index.
369 * Caller is responsible for discarding the cache_entry
370 * with `discard_cache_entry`.
371 */
372struct cache_entry *make_transient_cache_entry(unsigned int mode,
373 const struct object_id *oid,
374 const char *path,
375 int stage);
376
377struct cache_entry *make_empty_transient_cache_entry(size_t name_len);
378
379/*
380 * Discard cache entry.
381 */
382void discard_cache_entry(struct cache_entry *ce);
383
Jameson Miller8e72d672018-07-02 19:49:37[diff] [blame]384/*
Jameson Miller8616a2d2018-07-02 19:49:39[diff] [blame]385 * Check configuration if we should perform extra validation on cache
386 * entries.
387 */
388int should_validate_cache_entries(void);
389
390/*
Jameson Miller8e72d672018-07-02 19:49:37[diff] [blame]391 * Duplicate a cache_entry. Allocate memory for the new entry from a
392 * memory_pool. Takes into account cache_entry fields that are meant
393 * for managing the underlying memory allocation of the cache_entry.
394 */
395struct cache_entry *dup_cache_entry(const struct cache_entry *ce, struct index_state *istate);
396
397/*
398 * Validate the cache entries in the index. This is an internal
399 * consistency check that the cache_entry structs are allocated from
400 * the expected memory pool.
401 */
402void validate_cache_entries(const struct index_state *istate);
403
Junio C Hamano4aab5b42007-04-02 06:26:07[diff] [blame]404#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
Junio C Hamano228e94f2007-04-02 01:14:06[diff] [blame]405#define active_cache (the_index.cache)
406#define active_nr (the_index.cache_nr)
407#define active_alloc (the_index.cache_alloc)
408#define active_cache_changed (the_index.cache_changed)
409#define active_cache_tree (the_index.cache_tree)
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]410
Junio C Hamano4aab5b42007-04-02 06:26:07[diff] [blame]411#define read_cache() read_index(&the_index)
Thomas Gummerera125a222018-01-07 22:30:13[diff] [blame]412#define read_cache_from(path) read_index_from(&the_index, (path), (get_git_dir()))
Nguyễn Thái Ngọc Duyae9af122018-09-15 17:56:04[diff] [blame]413#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec), 0)
Junio C Hamanofa7b3c22008-11-12 19:52:35[diff] [blame]414#define is_cache_unborn() is_index_unborn(&the_index)
Miklos Vajnae46bbcf2008-06-27 16:21:58[diff] [blame]415#define read_cache_unmerged() read_index_unmerged(&the_index)
Junio C Hamano4aab5b42007-04-02 06:26:07[diff] [blame]416#define discard_cache() discard_index(&the_index)
Daniel Barkalow94a57282008-02-07 16:40:13[diff] [blame]417#define unmerged_cache() unmerged_index(&the_index)
Junio C Hamano4aab5b42007-04-02 06:26:07[diff] [blame]418#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
419#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
Petr Baudis81dc2302008-07-21 00:25:56[diff] [blame]420#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
Junio C Hamano4aab5b42007-04-02 06:26:07[diff] [blame]421#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
422#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
Thomas Gummerer610d55a2016-09-14 21:07:47[diff] [blame]423#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
424#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
Thomas Gummererd9d70962016-09-14 21:07:46[diff] [blame]425#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
Matthieu Moy3deffc52009-08-21 08:57:59[diff] [blame]426#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
Junio C Hamano4bd5b7d2007-11-10 08:15:03[diff] [blame]427#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
428#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
Eric Sunshinedb5360f2013-09-17 07:06:14[diff] [blame]429#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
430#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
Jeff King98fa4732008-10-16 15:07:26[diff] [blame]431#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
Junio C Hamanocfc57892009-12-25 08:30:51[diff] [blame]432#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
Junio C Hamano8aa38562009-12-25 21:40:02[diff] [blame]433#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
Junio C Hamano4421a822009-12-25 19:57:11[diff] [blame]434#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
Lukas Fleischerff366822013-04-13 13:28:31[diff] [blame]435#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
Junio C Hamano4aab5b42007-04-02 06:26:07[diff] [blame]436#endif
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]437
Nguyễn Thái Ngọc Duyfd9b1ba2018-04-14 15:35:01[diff] [blame]438#define TYPE_BITS 3
439
Nguyễn Thái Ngọc Duy011b6482018-05-11 06:55:23[diff] [blame]440/*
441 * Values in this enum (except those outside the 3 bit range) are part
442 * of pack file format. See Documentation/technical/pack-format.txt
443 * for more information.
444 */
Junio C Hamanoedaec3f2007-02-28 19:45:56[diff] [blame]445enum object_type {
446 OBJ_BAD = -1,
447 OBJ_NONE = 0,
448 OBJ_COMMIT = 1,
449 OBJ_TREE = 2,
450 OBJ_BLOB = 3,
451 OBJ_TAG = 4,
452 /* 5 for future expansion */
453 OBJ_OFS_DELTA = 6,
454 OBJ_REF_DELTA = 7,
Martin Koegler355885d2008-02-25 21:46:04[diff] [blame]455 OBJ_ANY,
Gary V. Vaughan4b055482010-05-14 09:31:35[diff] [blame]456 OBJ_MAX
Junio C Hamanoedaec3f2007-02-28 19:45:56[diff] [blame]457};
458
Junio C Hamanob45563a2007-12-01 06:22:38[diff] [blame]459static inline enum object_type object_type(unsigned int mode)
460{
461 return S_ISDIR(mode) ? OBJ_TREE :
462 S_ISGITLINK(mode) ? OBJ_COMMIT :
463 OBJ_BLOB;
464}
465
Jeff King2163e5d2013-03-08 09:29:08[diff] [blame]466/* Double-check local_repo_env below if you add to this list. */
Junio C Hamano8ac069a2005-05-10 05:57:58[diff] [blame]467#define GIT_DIR_ENVIRONMENT "GIT_DIR"
Nguyễn Thái Ngọc Duyc7b3a3d2014-11-30 08:24:36[diff] [blame]468#define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
Josh Tripletta1bea2c2011-07-05 17:54:44[diff] [blame]469#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
Matthias Lederhofer892c41b2007-06-06 07:10:42[diff] [blame]470#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
Jeff Kinga6f7f9a2013-03-08 09:30:25[diff] [blame]471#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
Brandon Williams74866d72016-10-07 18:18:48[diff] [blame]472#define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
Junio C Hamano8ac069a2005-05-10 05:57:58[diff] [blame]473#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
Junio C Hamanod19938a2005-05-10 00:57:56[diff] [blame]474#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
Linus Torvaldsbb233d62005-04-21 17:55:18[diff] [blame]475#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
Junio C Hamano5da5c8f2005-07-30 07:58:28[diff] [blame]476#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
Nguyễn Thái Ngọc Duy069c0532013-12-05 13:02:45[diff] [blame]477#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
Junio C Hamanod4ebc362006-12-19 09:28:15[diff] [blame]478#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
479#define CONFIG_ENVIRONMENT "GIT_CONFIG"
Jeff King2b64fc82010-08-23 19:16:00[diff] [blame]480#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
Junio C Hamanod4ebc362006-12-19 09:28:15[diff] [blame]481#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
David Reiss0454dd92008-05-20 06:49:26[diff] [blame]482#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
Christian Couder6476b382009-11-18 06:50:58[diff] [blame]483#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
Mike Hommey58d121b2015-06-11 21:34:59[diff] [blame]484#define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
Junio C Hamanod0bfd022007-04-12 08:07:32[diff] [blame]485#define GITATTRIBUTES_FILE ".gitattributes"
486#define INFOATTRIBUTES_FILE "info/attributes"
Junio C Hamanof48fd682007-04-14 15:54:37[diff] [blame]487#define ATTRIBUTE_MACRO_PREFIX "[attr]"
Brandon Williams4c0eeaf2017-08-02 19:49:16[diff] [blame]488#define GITMODULES_FILE ".gitmodules"
Antonio Ospiteb5c259f2018-10-05 13:05:59[diff] [blame]489#define GITMODULES_INDEX ":.gitmodules"
490#define GITMODULES_HEAD "HEAD:.gitmodules"
Johannes Schindelina97a7462009-10-09 10:21:57[diff] [blame]491#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
492#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
Thomas Rast894a9d32010-03-12 17:04:26[diff] [blame]493#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
Thomas Rast6956f852010-03-12 17:04:32[diff] [blame]494#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
495#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
Jeff King823ab402012-12-19 22:37:30[diff] [blame]496#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
Nguyễn Thái Ngọc Duybd30c2e2013-07-14 08:36:08[diff] [blame]497#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
498#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
Nguyễn Thái Ngọc Duy93d93532013-07-14 08:36:09[diff] [blame]499#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
Jeff Kinge34c2e02016-10-03 20:49:18[diff] [blame]500#define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
Jeff King27344d62017-09-27 06:54:30[diff] [blame]501#define GIT_OPTIONAL_LOCKS_ENVIRONMENT "GIT_OPTIONAL_LOCKS"
Dan Jacques226c0dd2018-04-10 15:05:44[diff] [blame]502#define GIT_TEXT_DOMAIN_DIR_ENVIRONMENT "GIT_TEXTDOMAINDIR"
Linus Torvaldsbb233d62005-04-21 17:55:18[diff] [blame]503
Giuseppe Bilotta48a7c1c2010-02-24 23:34:14[diff] [blame]504/*
Brandon Williams373d70e2017-10-16 17:55:24[diff] [blame]505 * Environment variable used in handshaking the wire protocol.
506 * Contains a colon ':' separated list of keys with optional values
507 * 'key[=value]'. Presence of unknown keys and values must be
508 * ignored.
509 */
510#define GIT_PROTOCOL_ENVIRONMENT "GIT_PROTOCOL"
Brandon Williams19113a22017-10-16 17:55:29[diff] [blame]511/* HTTP header used to handshake the wire protocol */
512#define GIT_PROTOCOL_HEADER "Git-Protocol"
Brandon Williams373d70e2017-10-16 17:55:24[diff] [blame]513
514/*
Jeff King2cd83d12013-03-08 09:32:22[diff] [blame]515 * This environment variable is expected to contain a boolean indicating
516 * whether we should or should not treat:
517 *
518 * GIT_DIR=foo.git git ...
519 *
520 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
521 * of this, but we use it internally to communicate to sub-processes that we
522 * are in a bare repo. If not set, defaults to true.
Giuseppe Bilotta48a7c1c2010-02-24 23:34:14[diff] [blame]523 */
Jeff King2cd83d12013-03-08 09:32:22[diff] [blame]524#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
525
526/*
Jeff King2163e5d2013-03-08 09:29:08[diff] [blame]527 * Repository-local GIT_* environment variables; these will be cleared
528 * when git spawns a sub-process that runs inside another repository.
529 * The array is NULL-terminated, which makes it easy to pass in the "env"
530 * parameter of a run-command invocation, or to do a simple walk.
Giuseppe Bilotta48a7c1c2010-02-24 23:34:14[diff] [blame]531 */
Jeff King2163e5d2013-03-08 09:29:08[diff] [blame]532extern const char * const local_repo_env[];
Giuseppe Bilotta48a7c1c2010-02-24 23:34:14[diff] [blame]533
Nguyễn Thái Ngọc Duy357a03e2018-03-03 11:35:55[diff] [blame]534extern void setup_git_env(const char *git_dir);
Brandon Williams73f192c2017-06-20 19:19:32[diff] [blame]535
Jeff Kingb9605bc2016-09-13 03:24:15[diff] [blame]536/*
537 * Returns true iff we have a configured git repository (either via
538 * setup_git_directory, or in the environment via $GIT_DIR).
539 */
540int have_git_dir(void);
541
Junio C Hamano7d1864c2007-01-07 10:00:28[diff] [blame]542extern int is_bare_repository_cfg;
543extern int is_bare_repository(void);
Johannes Schindelin68025632007-01-20 02:09:34[diff] [blame]544extern int is_inside_git_dir(void);
Johannes Schindeline90fdc32007-08-01 00:30:14[diff] [blame]545extern char *git_work_tree_cfg;
Matthias Lederhofer892c41b2007-06-06 07:10:42[diff] [blame]546extern int is_inside_work_tree(void);
Pierre Habouzitc5fba162006-08-23 10:39:11[diff] [blame]547extern const char *get_git_dir(void);
Nguyễn Thái Ngọc Duyc7b3a3d2014-11-30 08:24:36[diff] [blame]548extern const char *get_git_common_dir(void);
Junio C Hamano8ac069a2005-05-10 05:57:58[diff] [blame]549extern char *get_object_directory(void);
Junio C Hamano8ac069a2005-05-10 05:57:58[diff] [blame]550extern char *get_index_file(void);
Stefan Beller0437a2e2018-05-17 22:51:50[diff] [blame]551extern char *get_graft_file(struct repository *r);
Jeff King48988c42018-03-30 18:34:46[diff] [blame]552extern void set_git_dir(const char *path);
Max Kirillov11f9dd72015-09-13 22:17:42[diff] [blame]553extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
Nguyễn Thái Ngọc Duy31e26eb2014-11-30 08:24:44[diff] [blame]554extern int get_common_dir(struct strbuf *sb, const char *gitdir);
Josh Tripletta1bea2c2011-07-05 17:54:44[diff] [blame]555extern const char *get_git_namespace(void);
556extern const char *strip_namespace(const char *namespaced_ref);
Brandon Williams74866d72016-10-07 18:18:48[diff] [blame]557extern const char *get_super_prefix(void);
Johannes Schindeline90fdc32007-08-01 00:30:14[diff] [blame]558extern const char *get_git_work_tree(void);
Erik Elfströma93beda2015-06-09 18:24:35[diff] [blame]559
Jeff Kingffd036b2016-01-22 22:27:33[diff] [blame]560/*
561 * Return true if the given path is a git directory; note that this _just_
562 * looks at the directory itself. If you want to know whether "foo/.git"
563 * is a repository, you must feed that path, not just "foo".
564 */
565extern int is_git_directory(const char *path);
566
567/*
568 * Return 1 if the given path is the root of a git repository or
569 * submodule, else 0. Will not return 1 for bare repositories with the
570 * exception of creating a bare repository in "foo/.git" and calling
571 * is_git_repository("foo").
572 *
573 * If we run into read errors, we err on the side of saying "yes, it is",
574 * as we usually consider sub-repos precious, and would prefer to err on the
575 * side of not disrupting or deleting them.
576 */
577extern int is_nonbare_repository_dir(struct strbuf *path);
578
Erik Elfströma93beda2015-06-09 18:24:35[diff] [blame]579#define READ_GITFILE_ERR_STAT_FAILED 1
580#define READ_GITFILE_ERR_NOT_A_FILE 2
581#define READ_GITFILE_ERR_OPEN_FAILED 3
582#define READ_GITFILE_ERR_READ_FAILED 4
583#define READ_GITFILE_ERR_INVALID_FORMAT 5
584#define READ_GITFILE_ERR_NO_PATH 6
585#define READ_GITFILE_ERR_NOT_A_REPO 7
Erik Elfström921bdd92015-06-15 19:39:52[diff] [blame]586#define READ_GITFILE_ERR_TOO_LARGE 8
Stefan Beller5f294332017-01-24 23:56:50[diff] [blame]587extern void read_gitfile_error_die(int error_code, const char *path, const char *dir);
Erik Elfströma93beda2015-06-09 18:24:35[diff] [blame]588extern const char *read_gitfile_gently(const char *path, int *return_error_code);
589#define read_gitfile(path) read_gitfile_gently((path), NULL)
Stefan Beller40d96322017-01-24 23:56:49[diff] [blame]590extern const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
591#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
592
Daniel Barkalow19757d82008-04-27 17:39:21[diff] [blame]593extern void set_git_work_tree(const char *tree);
Junio C Hamano8ac069a2005-05-10 05:57:58[diff] [blame]594
595#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
Linus Torvaldsbb233d62005-04-21 17:55:18[diff] [blame]596
Mike Hommey59f0f2f2007-11-03 11:23:11[diff] [blame]597extern void setup_work_tree(void);
Johannes Schindelin16ac8b82017-03-13 20:10:45[diff] [blame]598/*
Brandon Williamsd3fb71b2017-06-14 18:07:37[diff] [blame]599 * Find the commondir and gitdir of the repository that contains the current
600 * working directory, without changing the working directory or other global
601 * state. The result is appended to commondir and gitdir. If the discovered
602 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
603 * both have the same result appended to the buffer. The return value is
604 * either 0 upon success and non-zero if no repository was found.
Johannes Schindelin16ac8b82017-03-13 20:10:45[diff] [blame]605 */
Brandon Williamsd3fb71b2017-06-14 18:07:37[diff] [blame]606extern int discover_git_directory(struct strbuf *commondir,
607 struct strbuf *gitdir);
Junio C Hamano4ca06602005-11-26 07:14:15[diff] [blame]608extern const char *setup_git_directory_gently(int *);
Linus Torvaldsd288a702005-08-17 01:06:34[diff] [blame]609extern const char *setup_git_directory(void);
Nguyễn Thái Ngọc Duyedc54fb2010-11-11 14:08:03[diff] [blame]610extern char *prefix_path(const char *prefix, int len, const char *path);
Nguyễn Thái Ngọc Duy645a29c2013-07-14 08:36:03[diff] [blame]611extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
Jeff King59801972017-03-21 01:21:27[diff] [blame]612
613/*
614 * Concatenate "prefix" (if len is non-zero) and "path", with no
615 * connecting characters (so "prefix" should end with a "/").
616 * Unlike prefix_path, this should be used if the named file does
617 * not have to interact with index entry; i.e. name of a random file
618 * on the filesystem.
619 *
Jeff Kinge4da43b2017-03-21 01:28:49[diff] [blame]620 * The return value is always a newly allocated string (even if the
621 * prefix was empty).
Jeff King59801972017-03-21 01:21:27[diff] [blame]622 */
Jeff Kinge4da43b2017-03-21 01:28:49[diff] [blame]623extern char *prefix_filename(const char *prefix, const char *path);
Jeff King59801972017-03-21 01:21:27[diff] [blame]624
Junio C Hamanoc6e8c802009-10-18 07:27:24[diff] [blame]625extern int check_filename(const char *prefix, const char *name);
Matthieu Moy023e37c2012-06-18 18:18:21[diff] [blame]626extern void verify_filename(const char *prefix,
627 const char *name,
628 int diagnose_misspelt_rev);
Junio C Hamanoea92f412006-04-26 22:09:27[diff] [blame]629extern void verify_non_filename(const char *prefix, const char *name);
Jeff King546e0fd2012-06-21 18:09:50[diff] [blame]630extern int path_inside_repo(const char *prefix, const char *path);
Linus Torvaldsd288a702005-08-17 01:06:34[diff] [blame]631
Daniel Barkalowf225aeb2008-04-27 17:39:27[diff] [blame]632#define INIT_DB_QUIET 0x0001
Nguyễn Thái Ngọc Duy33158702016-09-25 03:14:37[diff] [blame]633#define INIT_DB_EXIST_OK 0x0002
Daniel Barkalowf225aeb2008-04-27 17:39:27[diff] [blame]634
Nguyễn Thái Ngọc Duy33158702016-09-25 03:14:37[diff] [blame]635extern int init_db(const char *git_dir, const char *real_git_dir,
636 const char *template_dir, unsigned int flags);
Daniel Barkalowf225aeb2008-04-27 17:39:27[diff] [blame]637
Thomas Rast1d999dd2013-07-16 09:27:36[diff] [blame]638extern void sanitize_stdfds(void);
Nguyễn Thái Ngọc Duyde0957c2014-02-08 07:08:51[diff] [blame]639extern int daemonize(void);
Thomas Rast1d999dd2013-07-16 09:27:36[diff] [blame]640
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]641#define alloc_nr(x) (((x)+16)*3/2)
642
Jeff King6815e562007-06-11 13:39:44[diff] [blame]643/*
644 * Realloc the buffer pointed at by variable 'x' so that it can hold
645 * at least 'nr' entries; the number of entries currently allocated
646 * is 'alloc', using the standard growing factor alloc_nr() macro.
647 *
Jonathan Nieder01f6fd42010-10-08 16:46:59[diff] [blame]648 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
Jeff King6815e562007-06-11 13:39:44[diff] [blame]649 */
650#define ALLOC_GROW(x, nr, alloc) \
651 do { \
Jeff Kingc927e6c2007-06-16 22:37:39[diff] [blame]652 if ((nr) > alloc) { \
Junio C Hamano4234a762007-06-12 05:10:55[diff] [blame]653 if (alloc_nr(alloc) < (nr)) \
654 alloc = (nr); \
655 else \
656 alloc = alloc_nr(alloc); \
René Scharfe2756ca42014-09-16 18:56:57[diff] [blame]657 REALLOC_ARRAY(x, alloc); \
Jeff King6815e562007-06-11 13:39:44[diff] [blame]658 } \
Jonathan Nieder98746062010-08-12 22:11:15[diff] [blame]659 } while (0)
Jeff King6815e562007-06-11 13:39:44[diff] [blame]660
Linus Torvalds734aab72005-04-09 16:48:20[diff] [blame]661/* Initialize and use the cache information */
Nguyễn Thái Ngọc Duy03b86642014-06-13 12:19:23[diff] [blame]662struct lock_file;
Junio C Hamano4aab5b42007-04-02 06:26:07[diff] [blame]663extern int read_index(struct index_state *);
Ben Peart99ce7202018-10-29 20:41:59[diff] [blame]664extern void preload_index(struct index_state *index,
665 const struct pathspec *pathspec,
666 unsigned int refresh_flags);
Nguyễn Thái Ngọc Duyae9af122018-09-15 17:56:04[diff] [blame]667extern int read_index_preload(struct index_state *,
668 const struct pathspec *pathspec,
669 unsigned int refresh_flags);
Nguyễn Thái Ngọc Duy3e52f702014-06-13 12:19:51[diff] [blame]670extern int do_read_index(struct index_state *istate, const char *path,
671 int must_exist); /* for testting only! */
Thomas Gummerera125a222018-01-07 22:30:13[diff] [blame]672extern int read_index_from(struct index_state *, const char *path,
673 const char *gitdir);
Junio C Hamanofa7b3c22008-11-12 19:52:35[diff] [blame]674extern int is_index_unborn(struct index_state *);
Miklos Vajnae46bbcf2008-06-27 16:21:58[diff] [blame]675extern int read_index_unmerged(struct index_state *);
Martin Ågren8dc38342017-10-05 20:32:11[diff] [blame]676
677/* For use with `write_locked_index()`. */
Nguyễn Thái Ngọc Duy03b86642014-06-13 12:19:23[diff] [blame]678#define COMMIT_LOCK (1 << 0)
Martin Ågren61000812018-03-01 20:40:20[diff] [blame]679#define SKIP_IF_UNCHANGED (1 << 1)
Martin Ågren8dc38342017-10-05 20:32:11[diff] [blame]680
681/*
Martin Ågren812d6b02017-10-06 20:12:12[diff] [blame]682 * Write the index while holding an already-taken lock. Close the lock,
683 * and if `COMMIT_LOCK` is given, commit it.
Martin Ågren8dc38342017-10-05 20:32:11[diff] [blame]684 *
685 * Unless a split index is in use, write the index into the lockfile.
686 *
687 * With a split index, write the shared index to a temporary file,
688 * adjust its permissions and rename it into place, then write the
689 * split index to the lockfile. If the temporary file for the shared
690 * index cannot be created, fall back to the behavior described in
691 * the previous paragraph.
Martin Ågrendf60cf52017-10-06 20:12:13[diff] [blame]692 *
693 * With `COMMIT_LOCK`, the lock is always committed or rolled back.
694 * Without it, the lock is closed, but neither committed nor rolled
695 * back.
Martin Ågren61000812018-03-01 20:40:20[diff] [blame]696 *
697 * If `SKIP_IF_UNCHANGED` is given and the index is unchanged, nothing
698 * is written (and the lock is rolled back if `COMMIT_LOCK` is given).
Martin Ågren8dc38342017-10-05 20:32:11[diff] [blame]699 */
Nguyễn Thái Ngọc Duy03b86642014-06-13 12:19:23[diff] [blame]700extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
Martin Ågren8dc38342017-10-05 20:32:11[diff] [blame]701
Junio C Hamano4aab5b42007-04-02 06:26:07[diff] [blame]702extern int discard_index(struct index_state *);
David Turneredf3b902017-05-08 09:41:42[diff] [blame]703extern void move_index_extensions(struct index_state *dst, struct index_state *src);
Linus Torvaldsd1f128b2008-03-06 20:46:09[diff] [blame]704extern int unmerged_index(const struct index_state *);
Elijah Newrenb1017932017-12-21 19:19:06[diff] [blame]705
706/**
Elijah Newrene1f86942018-07-01 01:25:00[diff] [blame]707 * Returns 1 if istate differs from tree, 0 otherwise. If tree is NULL,
708 * compares istate to HEAD. If tree is NULL and on an unborn branch,
709 * returns 1 if there are entries in istate, 0 otherwise. If an strbuf is
710 * provided, the space-separated list of files that differ will be appended
711 * to it.
Elijah Newrenb1017932017-12-21 19:19:06[diff] [blame]712 */
Nguyễn Thái Ngọc Duy92a1bf52018-09-21 15:57:18[diff] [blame]713extern int index_has_changes(struct index_state *istate,
Elijah Newrene1f86942018-07-01 01:25:00[diff] [blame]714 struct tree *tree,
Elijah Newren1b9fbef2018-07-01 01:24:56[diff] [blame]715 struct strbuf *sb);
Elijah Newrenb1017932017-12-21 19:19:06[diff] [blame]716
Jeff King10ecfa72018-05-05 00:03:35[diff] [blame]717extern int verify_path(const char *path, unsigned mode);
Jeff Hostetlera6db3fb2017-04-14 19:12:28[diff] [blame]718extern int strcmp_offset(const char *s1, const char *s2, size_t *first_change);
David Turner41284eb2015-10-21 17:54:11[diff] [blame]719extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
720extern void adjust_dirname_case(struct index_state *istate, char *name);
Eric Sunshinedb5360f2013-09-17 07:06:14[diff] [blame]721extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
Stefan Beller12733e92017-01-19 03:18:51[diff] [blame]722
723/*
724 * Searches for an entry defined by name and namelen in the given index.
725 * If the return value is positive (including 0) it is the position of an
726 * exact match. If the return value is negative, the negated value minus 1
727 * is the position where the entry would be inserted.
728 * Example: The current index consists of these files and its stages:
729 *
730 * b#0, d#0, f#1, f#3
731 *
732 * index_name_pos(&index, "a", 1) -> -1
733 * index_name_pos(&index, "b", 1) -> 0
734 * index_name_pos(&index, "c", 1) -> -2
735 * index_name_pos(&index, "d", 1) -> 1
736 * index_name_pos(&index, "e", 1) -> -3
737 * index_name_pos(&index, "f", 1) -> -3
738 * index_name_pos(&index, "g", 1) -> -5
739 */
Linus Torvaldsd1f128b2008-03-06 20:46:09[diff] [blame]740extern int index_name_pos(const struct index_state *, const char *name, int namelen);
Stefan Beller12733e92017-01-19 03:18:51[diff] [blame]741
Junio C Hamano192268c2005-05-08 04:55:21[diff] [blame]742#define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
743#define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
Junio C Hamanob1557252005-06-25 09:25:29[diff] [blame]744#define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
Junio C Hamanoaf3785d2007-08-09 20:42:50[diff] [blame]745#define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
Junio C Hamano39425812008-08-21 08:44:53[diff] [blame]746#define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
Nguyễn Thái Ngọc Duyce7c6142014-06-13 12:19:42[diff] [blame]747#define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
Junio C Hamano4aab5b42007-04-02 06:26:07[diff] [blame]748extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
Petr Baudis81dc2302008-07-21 00:25:56[diff] [blame]749extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
Stefan Beller3bd72ad2017-01-19 03:18:52[diff] [blame]750
751/* Remove entry, return true if there are more entries to go. */
Junio C Hamano4aab5b42007-04-02 06:26:07[diff] [blame]752extern int remove_index_entry_at(struct index_state *, int pos);
Stefan Beller3bd72ad2017-01-19 03:18:52[diff] [blame]753
Kjetil Barvik36419c82009-02-18 22:18:03[diff] [blame]754extern void remove_marked_cache_entries(struct index_state *istate);
Junio C Hamano4aab5b42007-04-02 06:26:07[diff] [blame]755extern int remove_file_from_index(struct index_state *, const char *path);
Junio C Hamano38ed1d82008-05-21 19:04:34[diff] [blame]756#define ADD_CACHE_VERBOSE 1
757#define ADD_CACHE_PRETEND 2
Junio C Hamano01665922008-05-25 21:03:50[diff] [blame]758#define ADD_CACHE_IGNORE_ERRORS 4
Junio C Hamano041aee32008-07-21 08:24:17[diff] [blame]759#define ADD_CACHE_IGNORE_REMOVAL 8
Junio C Hamano39425812008-08-21 08:44:53[diff] [blame]760#define ADD_CACHE_INTENT 16
Stefan Beller20cf41d2017-01-19 03:18:53[diff] [blame]761/*
762 * These two are used to add the contents of the file at path
763 * to the index, marking the working tree up-to-date by storing
764 * the cached stat info in the resulting cache entry. A caller
765 * that has already run lstat(2) on the path can call
766 * add_to_index(), and all others can call add_file_to_index();
767 * the latter will do necessary lstat(2) internally before
768 * calling the former.
769 */
Thomas Gummerer610d55a2016-09-14 21:07:47[diff] [blame]770extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
771extern int add_file_to_index(struct index_state *, const char *path, int flags);
Stefan Beller20cf41d2017-01-19 03:18:53[diff] [blame]772
Thomas Gummererd9d70962016-09-14 21:07:46[diff] [blame]773extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
Nguyễn Thái Ngọc Duy9c5e6c82013-07-09 15:29:00[diff] [blame]774extern 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:09[diff] [blame]775extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
Jeff King98fa4732008-10-16 15:07:26[diff] [blame]776extern int index_name_is_other(const struct index_state *, const char *, int);
Brandon Williams87542502017-01-10 20:06:10[diff] [blame]777extern void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *);
Junio C Hamano4bd5b7d2007-11-10 08:15:03[diff] [blame]778
779/* do stat comparison even if CE_VALID is true */
780#define CE_MATCH_IGNORE_VALID 01
781/* do not check the contents but report dirty on racily-clean entries */
Nguyễn Thái Ngọc Duy56cac482009-12-14 11:43:58[diff] [blame]782#define CE_MATCH_RACY_IS_DIRTY 02
783/* do stat comparison even if CE_SKIP_WORKTREE is true */
784#define CE_MATCH_IGNORE_SKIP_WORKTREE 04
Brad King2e2e7ec2014-01-27 14:45:07[diff] [blame]785/* ignore non-existent files during stat update */
786#define CE_MATCH_IGNORE_MISSING 0x08
Brad King25762722014-01-27 14:45:08[diff] [blame]787/* enable stat refresh */
788#define CE_MATCH_REFRESH 0x10
Ben Peart883e2482017-09-22 16:35:40[diff] [blame]789/* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */
790#define CE_MATCH_IGNORE_FSMONITOR 0X20
SZEDER Gábor5581a012018-10-11 09:43:09[diff] [blame]791extern int is_racy_timestamp(const struct index_state *istate,
792 const struct cache_entry *ce);
Ben Peart883e2482017-09-22 16:35:40[diff] [blame]793extern int ie_match_stat(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
794extern int ie_modified(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
Junio C Hamano4bd5b7d2007-11-10 08:15:03[diff] [blame]795
Junio C Hamanoc4ce46f2011-05-08 08:47:33[diff] [blame]796#define HASH_WRITE_OBJECT 1
797#define HASH_FORMAT_CHECK 2
Torsten Bögershausen94729352017-11-16 16:38:28[diff] [blame]798#define HASH_RENORMALIZE 4
Nguyễn Thái Ngọc Duy58bf2a42018-09-21 15:57:31[diff] [blame]799extern int index_fd(struct index_state *istate, struct object_id *oid, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
800extern int index_path(struct index_state *istate, struct object_id *oid, const char *path, struct stat *st, unsigned flags);
Michael Haggertyc21d39d2013-06-20 08:37:50[diff] [blame]801
802/*
803 * Record to sd the data from st that we use to check whether a file
804 * might have changed.
805 */
806extern void fill_stat_data(struct stat_data *sd, struct stat *st);
807
808/*
809 * Return 0 if st is consistent with a file not having been changed
810 * since sd was filled. If there are differences, return a
811 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
812 * INODE_CHANGED, and DATA_CHANGED.
813 */
814extern int match_stat_data(const struct stat_data *sd, struct stat *st);
Nguyễn Thái Ngọc Duyed4efab2015-03-08 10:12:37[diff] [blame]815extern int match_stat_data_racy(const struct index_state *istate,
816 const struct stat_data *sd, struct stat *st);
Michael Haggertyc21d39d2013-06-20 08:37:50[diff] [blame]817
Junio C Hamano415e96c2005-05-15 21:23:12[diff] [blame]818extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
819
Linus Torvalds405e5b22006-05-19 16:56:35[diff] [blame]820#define REFRESH_REALLY 0x0001 /* ignore_valid */
821#define REFRESH_UNMERGED 0x0002 /* allow unmerged */
822#define REFRESH_QUIET 0x0004 /* be quiet about it */
823#define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
Junio C Hamano3f1b7b62008-07-20 06:25:00[diff] [blame]824#define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
Matthieu Moy43673fd2009-08-21 08:57:58[diff] [blame]825#define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
Nguyễn Thái Ngọc Duyae9af122018-09-15 17:56:04[diff] [blame]826#define REFRESH_PROGRESS 0x0040 /* show progress bar if stderr is tty */
Nguyễn Thái Ngọc Duy9b2d6142013-07-14 08:35:54[diff] [blame]827extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
Jameson Miller768d7962018-07-02 19:49:29[diff] [blame]828extern struct cache_entry *refresh_cache_entry(struct index_state *, struct cache_entry *, unsigned int);
Linus Torvalds405e5b22006-05-19 16:56:35[diff] [blame]829
Martin Ågrenb74c90f2017-10-06 20:12:14[diff] [blame]830/*
831 * Opportunistically update the index but do not complain if we can't.
832 * The lockfile is always committed or rolled back.
833 */
Junio C Hamanoccdc4ec2011-03-21 17:16:10[diff] [blame]834extern void update_index_if_able(struct index_state *, struct lock_file *);
Junio C Hamano30ca07a2007-04-01 06:09:02[diff] [blame]835
836extern int hold_locked_index(struct lock_file *, int);
Junio C Hamano5e7f56a2007-04-01 06:27:41[diff] [blame]837extern void set_alternate_index_output(const char *);
Michael Haggerty697cc8e2014-10-01 10:28:42[diff] [blame]838
Jeff Hostetlera33fc722017-04-14 20:32:21[diff] [blame]839extern int verify_index_checksum;
Ben Peart00ec50e2017-10-18 14:27:25[diff] [blame]840extern int verify_ce_order;
Jeff Hostetlera33fc722017-04-14 20:32:21[diff] [blame]841
Junio C Hamano2ae1c532006-02-27 22:47:45[diff] [blame]842/* Environment bits from configuration mechanism */
Linus Torvalds17712992005-10-10 23:31:08[diff] [blame]843extern int trust_executable_bit;
Alex Riesen1ce47902008-07-28 06:31:28[diff] [blame]844extern int trust_ctime;
Robin Rosenbergc08e4d52013-01-22 07:49:22[diff] [blame]845extern int check_stat;
Junio C Hamano9378c162007-06-24 22:11:24[diff] [blame]846extern int quote_path_fully;
Johannes Sixt78a8d642007-03-02 21:11:30[diff] [blame]847extern int has_symlinks;
Linus Torvaldsdce96482010-10-28 18:28:04[diff] [blame]848extern int minimum_abbrev, default_abbrev;
Linus Torvalds0a9b88b2008-03-21 23:52:46[diff] [blame]849extern int ignore_case;
Junio C Hamano5f730762006-02-09 05:15:24[diff] [blame]850extern int assume_unchanged;
Junio C Hamano9f0bb902006-05-02 07:40:24[diff] [blame]851extern int prefer_symlink_refs;
Junio C Hamano2f8acdb2006-03-21 02:45:47[diff] [blame]852extern int warn_ambiguous_refs;
Jeff King25fba782013-07-12 06:20:05[diff] [blame]853extern int warn_on_object_refname_ambiguity;
Junio C Hamano2ae1c532006-02-27 22:47:45[diff] [blame]854extern const char *apply_default_whitespace;
Giuseppe Bilotta86c91f92009-08-04 11:16:49[diff] [blame]855extern const char *apply_default_ignorewhitespace;
Junio C Hamano64589a02011-10-06 18:22:24[diff] [blame]856extern const char *git_attributes_file;
Ævar Arnfjörð Bjarmason867ad082016-05-04 22:58:12[diff] [blame]857extern const char *git_hooks_path;
Joachim B Haga12f6c302006-07-03 20:11:47[diff] [blame]858extern int zlib_compression_level;
Dana How960ccca2007-05-09 20:56:50[diff] [blame]859extern int core_compression_level;
Junio C Hamano8de7eeb2016-11-16 01:42:40[diff] [blame]860extern int pack_compression_level;
Shawn O. Pearce60bb8b12006-12-23 07:34:28[diff] [blame]861extern size_t packed_git_window_size;
Shawn O. Pearce77ccc5b2006-12-23 07:33:35[diff] [blame]862extern size_t packed_git_limit;
Shawn O. Pearce18bdec12007-03-19 05:14:37[diff] [blame]863extern size_t delta_base_cache_limit;
Junio C Hamano15366282011-04-05 17:44:11[diff] [blame]864extern unsigned long big_file_threshold;
Junio C Hamano568508e2011-10-28 21:48:40[diff] [blame]865extern unsigned long pack_size_limit_cfg;
Michael Haggertyafc711b2014-02-18 11:24:55[diff] [blame]866
Jeff King45439262016-09-13 03:24:23[diff] [blame]867/*
868 * Accessors for the core.sharedrepository config which lazy-load the value
869 * from the config (if not already set). The "reset" function can be
870 * used to unset "set" or cached value, meaning that the value will be loaded
871 * fresh from the config file on the next call to get_shared_repository().
872 */
Jeff King7875acb2016-03-11 22:36:49[diff] [blame]873void set_shared_repository(int value);
874int get_shared_repository(void);
Jeff King45439262016-09-13 03:24:23[diff] [blame]875void reset_shared_repository(void);
Jeff King7875acb2016-03-11 22:36:49[diff] [blame]876
Michael Haggertyafc711b2014-02-18 11:24:55[diff] [blame]877/*
878 * Do replace refs need to be checked this run? This variable is
879 * initialized to true unless --no-replace-object is used or
880 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
Jeff King72470aa2018-07-18 20:44:49[diff] [blame]881 * commands that do not want replace references to be active.
Michael Haggertyafc711b2014-02-18 11:24:55[diff] [blame]882 */
Jeff King6ebd1ca2018-07-18 20:45:20[diff] [blame]883extern int read_replace_refs;
Mike Hommey58d121b2015-06-11 21:34:59[diff] [blame]884extern char *git_replace_ref_base;
Michael Haggertyafc711b2014-02-18 11:24:55[diff] [blame]885
Linus Torvaldsaafe9fb2008-06-18 22:18:44[diff] [blame]886extern int fsync_object_files;
Linus Torvalds671c9b72008-11-14 00:36:30[diff] [blame]887extern int core_preload_index;
Nguyễn Thái Ngọc Duy08aefc92009-08-20 13:47:08[diff] [blame]888extern int core_apply_sparse_checkout;
Torsten Bögershausen76759c72012-07-08 13:50:25[diff] [blame]889extern int precomposed_unicode;
Jeff Kinga42643a2014-12-15 23:15:20[diff] [blame]890extern int protect_hfs;
Johannes Schindelin2b4c6ef2014-12-16 22:46:59[diff] [blame]891extern int protect_ntfs;
Ben Peart883e2482017-09-22 16:35:40[diff] [blame]892extern const char *core_fsmonitor;
Linus Torvalds17712992005-10-10 23:31:08[diff] [blame]893
Junio C Hamanoeff80a92013-01-16 19:18:48[diff] [blame]894/*
Jeff King49672f22015-03-20 18:43:06[diff] [blame]895 * Include broken refs in all ref iterations, which will
896 * generally choke dangerous operations rather than letting
897 * them silently proceed without taking the broken ref into
898 * account.
899 */
900extern int ref_paranoia;
901
902/*
Jeff King27344d62017-09-27 06:54:30[diff] [blame]903 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value).
904 */
905int use_optional_locks(void);
906
907/*
Junio C Hamanoeff80a92013-01-16 19:18:48[diff] [blame]908 * The character that begins a commented line in user-editable file
909 * that is subject to stripspace.
910 */
911extern char comment_line_char;
Nguyễn Thái Ngọc Duy84c9dc22014-05-17 01:52:23[diff] [blame]912extern int auto_comment_line_char;
Junio C Hamanoeff80a92013-01-16 19:18:48[diff] [blame]913
Cornelius Weig341fb282017-01-27 10:09:47[diff] [blame]914enum log_refs_config {
915 LOG_REFS_UNSET = -1,
916 LOG_REFS_NONE = 0,
917 LOG_REFS_NORMAL,
918 LOG_REFS_ALWAYS
919};
920extern enum log_refs_config log_all_ref_updates;
921
Dustin Sallingsc998ae92008-05-10 22:36:29[diff] [blame]922enum rebase_setup_type {
923 AUTOREBASE_NEVER = 0,
924 AUTOREBASE_LOCAL,
925 AUTOREBASE_REMOTE,
Gary V. Vaughan4b055482010-05-14 09:31:35[diff] [blame]926 AUTOREBASE_ALWAYS
Dustin Sallingsc998ae92008-05-10 22:36:29[diff] [blame]927};
928
Finn Arne Gangstad52153742009-03-16 15:42:51[diff] [blame]929enum push_default_type {
Finn Arne Gangstad52153742009-03-16 15:42:51[diff] [blame]930 PUSH_DEFAULT_NOTHING = 0,
931 PUSH_DEFAULT_MATCHING,
Matthieu Moyb55e67752012-04-24 07:50:03[diff] [blame]932 PUSH_DEFAULT_SIMPLE,
Johan Herland53c40312011-02-16 00:54:24[diff] [blame]933 PUSH_DEFAULT_UPSTREAM,
Christopher Tiwaldf25950f2012-03-20 04:31:33[diff] [blame]934 PUSH_DEFAULT_CURRENT,
935 PUSH_DEFAULT_UNSPECIFIED
Finn Arne Gangstad52153742009-03-16 15:42:51[diff] [blame]936};
937
Dustin Sallingsc998ae92008-05-10 22:36:29[diff] [blame]938extern enum rebase_setup_type autorebase;
Finn Arne Gangstad52153742009-03-16 15:42:51[diff] [blame]939extern enum push_default_type push_default;
Jay Soffian9ed36cf2008-02-19 16:24:37[diff] [blame]940
Johannes Schindelin348df162009-04-27 22:32:25[diff] [blame]941enum object_creation_mode {
942 OBJECT_CREATION_USES_HARDLINKS = 0,
Gary V. Vaughan4b055482010-05-14 09:31:35[diff] [blame]943 OBJECT_CREATION_USES_RENAMES = 1
Johannes Schindelin348df162009-04-27 22:32:25[diff] [blame]944};
945
946extern enum object_creation_mode object_creation_mode;
Johannes Schindelinbe66a6c2009-04-25 09:57:14[diff] [blame]947
Johannes Schindelina97a7462009-10-09 10:21:57[diff] [blame]948extern char *notes_ref_name;
949
Johannes Schindelin7f3140c2009-07-23 15:33:49[diff] [blame]950extern int grafts_replace_parents;
951
Jeff King00a09d52015-06-23 10:53:58[diff] [blame]952/*
953 * GIT_REPO_VERSION is the version we write by default. The
954 * _READ variant is the highest number we know how to
955 * handle.
956 */
Junio C Hamanoab9cb762005-11-25 23:59:09[diff] [blame]957#define GIT_REPO_VERSION 0
Jeff King00a09d52015-06-23 10:53:58[diff] [blame]958#define GIT_REPO_VERSION_READ 1
Jeff King067fbd42015-06-23 10:54:11[diff] [blame]959extern int repository_format_precious_objects;
Jonathan Tan75b97fe2017-12-05 16:58:43[diff] [blame]960extern char *repository_format_partial_clone;
Jeff Hostetler1e1e39b2017-12-08 15:58:45[diff] [blame]961extern const char *core_partial_clone_filter_default;
Nguyễn Thái Ngọc Duy58b284a2018-10-21 14:02:28[diff] [blame]962extern int repository_format_worktree_config;
Jeff King4b0d1ee2016-03-11 22:36:45[diff] [blame]963
Jeff King2cc7c2c2016-03-11 22:37:07[diff] [blame]964struct repository_format {
965 int version;
966 int precious_objects;
Jonathan Tan75b97fe2017-12-05 16:58:43[diff] [blame]967 char *partial_clone; /* value of extensions.partialclone */
Nguyễn Thái Ngọc Duy58b284a2018-10-21 14:02:28[diff] [blame]968 int worktree_config;
Jeff King2cc7c2c2016-03-11 22:37:07[diff] [blame]969 int is_bare;
brian m. carlson78a67662017-11-12 21:28:53[diff] [blame]970 int hash_algo;
Jeff King2cc7c2c2016-03-11 22:37:07[diff] [blame]971 char *work_tree;
972 struct string_list unknown_extensions;
973};
974
975/*
976 * Read the repository format characteristics from the config file "path" into
977 * "format" struct. Returns the numeric version. On error, -1 is returned,
978 * format->version is set to -1, and all other fields in the struct are
979 * undefined.
980 */
981int read_repository_format(struct repository_format *format, const char *path);
982
983/*
984 * Verify that the repository described by repository_format is something we
985 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
986 * any errors encountered.
987 */
988int verify_repository_format(const struct repository_format *format,
989 struct strbuf *err);
990
Jeff King4b0d1ee2016-03-11 22:36:45[diff] [blame]991/*
992 * Check the repository format version in the path found in get_git_dir(),
993 * and die if it is a version we don't understand. Generally one would
994 * set_git_dir() before calling this, and use it only for "are we in a valid
995 * repo?".
996 */
997extern void check_repository_format(void);
Junio C Hamanoab9cb762005-11-25 23:59:09[diff] [blame]998
Linus Torvalds734aab72005-04-09 16:48:20[diff] [blame]999#define MTIME_CHANGED 0x0001
1000#define CTIME_CHANGED 0x0002
1001#define OWNER_CHANGED 0x0004
1002#define MODE_CHANGED 0x0008
1003#define INODE_CHANGED 0x0010
1004#define DATA_CHANGED 0x0020
Kay Sievers8ae0a8c2005-05-05 12:38:25[diff] [blame]1005#define TYPE_CHANGED 0x0040
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]1006
Jeff King69ddd232015-08-10 09:32:07[diff] [blame]1007/*
Jeff Kingaf49c6d2015-09-24 21:05:45[diff] [blame]1008 * Return an abbreviated sha1 unique within this repository's object database.
1009 * The result will be at least `len` characters long, and will be NUL
1010 * terminated.
1011 *
Jeff Kingef2ed502016-10-20 06:19:19[diff] [blame]1012 * The non-`_r` version returns a static buffer which remains valid until 4
1013 * more calls to find_unique_abbrev are made.
Jeff Kingaf49c6d2015-09-24 21:05:45[diff] [blame]1014 *
1015 * The `_r` variant writes to a buffer supplied by the caller, which must be at
brian m. carlsonaab95832018-03-12 02:27:30[diff] [blame]1016 * least `GIT_MAX_HEXSZ + 1` bytes. The return value is the number of bytes
Jeff Kingaf49c6d2015-09-24 21:05:45[diff] [blame]1017 * written (excluding the NUL terminator).
1018 *
1019 * Note that while this version avoids the static buffer, it is not fully
1020 * reentrant, as it calls into other non-reentrant git code.
1021 */
brian m. carlsonaab95832018-03-12 02:27:30[diff] [blame]1022extern const char *find_unique_abbrev(const struct object_id *oid, int len);
1023extern int find_unique_abbrev_r(char *hex, const struct object_id *oid, int len);
Jeff Kingaf49c6d2015-09-24 21:05:45[diff] [blame]1024
brian m. carlsoncd025992017-03-26 16:01:25[diff] [blame]1025extern const unsigned char null_sha1[GIT_MAX_RAWSZ];
brian m. carlson3e56e722015-12-06 22:16:35[diff] [blame]1026extern const struct object_id null_oid;
Ingo Molnar1a812f32011-04-28 10:19:02[diff] [blame]1027
David Rientjesa89fccd2006-08-17 18:54:57[diff] [blame]1028static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
1029{
Jeff King183a6382018-08-23 05:02:25[diff] [blame]1030 /*
1031 * This is a temporary optimization hack. By asserting the size here,
1032 * we let the compiler know that it's always going to be 20, which lets
1033 * it turn this fixed-size memcmp into a few inline instructions.
1034 *
1035 * This will need to be extended or ripped out when we learn about
1036 * hashes of different sizes.
1037 */
1038 if (the_hash_algo->rawsz != 20)
1039 BUG("hash size not yet supported by hashcmp");
brian m. carlson509f6f62018-07-16 01:27:53[diff] [blame]1040 return memcmp(sha1, sha2, the_hash_algo->rawsz);
David Rientjesa89fccd2006-08-17 18:54:57[diff] [blame]1041}
Ingo Molnar1a812f32011-04-28 10:19:02[diff] [blame]1042
brian m. carlsonaa1c6fd2015-03-13 23:39:28[diff] [blame]1043static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
1044{
1045 return hashcmp(oid1->hash, oid2->hash);
1046}
1047
Jeff King14438c42018-08-28 21:22:35[diff] [blame]1048static inline int hasheq(const unsigned char *sha1, const unsigned char *sha2)
1049{
1050 return !hashcmp(sha1, sha2);
1051}
1052
1053static inline int oideq(const struct object_id *oid1, const struct object_id *oid2)
1054{
1055 return hasheq(oid1->hash, oid2->hash);
1056}
1057
Ingo Molnar1a812f32011-04-28 10:19:02[diff] [blame]1058static inline int is_null_sha1(const unsigned char *sha1)
1059{
Jeff Kinge3ff0682018-08-28 21:22:44[diff] [blame]1060 return hasheq(sha1, null_sha1);
Ingo Molnar1a812f32011-04-28 10:19:02[diff] [blame]1061}
1062
brian m. carlsonaa1c6fd2015-03-13 23:39:28[diff] [blame]1063static inline int is_null_oid(const struct object_id *oid)
1064{
Jeff Kinge3ff0682018-08-28 21:22:44[diff] [blame]1065 return hasheq(oid->hash, null_sha1);
brian m. carlsonaa1c6fd2015-03-13 23:39:28[diff] [blame]1066}
1067
Shawn Pearcee7024962006-08-23 06:49:00[diff] [blame]1068static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
1069{
brian m. carlson509f6f62018-07-16 01:27:53[diff] [blame]1070 memcpy(sha_dst, sha_src, the_hash_algo->rawsz);
Shawn Pearcee7024962006-08-23 06:49:00[diff] [blame]1071}
brian m. carlsonaa1c6fd2015-03-13 23:39:28[diff] [blame]1072
1073static inline void oidcpy(struct object_id *dst, const struct object_id *src)
1074{
1075 hashcpy(dst->hash, src->hash);
1076}
1077
Brandon Williams1c41c822017-05-30 17:30:44[diff] [blame]1078static inline struct object_id *oiddup(const struct object_id *src)
1079{
1080 struct object_id *dst = xmalloc(sizeof(struct object_id));
1081 oidcpy(dst, src);
1082 return dst;
1083}
1084
Junio C Hamanoa8e0d162006-08-23 20:57:23[diff] [blame]1085static inline void hashclr(unsigned char *hash)
1086{
brian m. carlson509f6f62018-07-16 01:27:53[diff] [blame]1087 memset(hash, 0, the_hash_algo->rawsz);
Junio C Hamanoa8e0d162006-08-23 20:57:23[diff] [blame]1088}
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]1089
brian m. carlsonaa1c6fd2015-03-13 23:39:28[diff] [blame]1090static inline void oidclr(struct object_id *oid)
1091{
Patryk Obara97a41a02018-01-28 00:13:14[diff] [blame]1092 memset(oid->hash, 0, GIT_MAX_RAWSZ);
brian m. carlsonaa1c6fd2015-03-13 23:39:28[diff] [blame]1093}
1094
brian m. carlson69d12422018-05-02 00:25:29[diff] [blame]1095static inline void oidread(struct object_id *oid, const unsigned char *hash)
1096{
1097 memcpy(oid->hash, hash, the_hash_algo->rawsz);
1098}
Jeff Kingf8582ca2012-03-22 18:53:39[diff] [blame]1099
1100static inline int is_empty_blob_sha1(const unsigned char *sha1)
1101{
Jeff Kinge3ff0682018-08-28 21:22:44[diff] [blame]1102 return hasheq(sha1, the_hash_algo->empty_blob->hash);
Jeff Kingf8582ca2012-03-22 18:53:39[diff] [blame]1103}
1104
Jacob Keller8576fde2016-08-31 23:27:18[diff] [blame]1105static inline int is_empty_blob_oid(const struct object_id *oid)
1106{
Jeff King4a7e27e2018-08-28 21:22:40[diff] [blame]1107 return oideq(oid, the_hash_algo->empty_blob);
Jacob Keller8576fde2016-08-31 23:27:18[diff] [blame]1108}
1109
1110static inline int is_empty_tree_sha1(const unsigned char *sha1)
1111{
Jeff Kinge3ff0682018-08-28 21:22:44[diff] [blame]1112 return hasheq(sha1, the_hash_algo->empty_tree->hash);
Jacob Keller8576fde2016-08-31 23:27:18[diff] [blame]1113}
1114
1115static inline int is_empty_tree_oid(const struct object_id *oid)
1116{
Jeff King4a7e27e2018-08-28 21:22:40[diff] [blame]1117 return oideq(oid, the_hash_algo->empty_tree);
Jacob Keller8576fde2016-08-31 23:27:18[diff] [blame]1118}
1119
brian m. carlsond8a92ce2018-05-02 00:25:54[diff] [blame]1120const char *empty_tree_oid_hex(void);
1121const char *empty_blob_oid_hex(void);
1122
Matthieu Moyb862b612010-02-22 22:32:13[diff] [blame]1123/* set default permissions by passing mode arguments to open(2) */
1124int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
1125int git_mkstemp_mode(char *pattern, int mode);
1126
Heikki Orsila06cbe852008-04-16 08:34:24[diff] [blame]1127/*
1128 * NOTE NOTE NOTE!!
1129 *
1130 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1131 * not be changed. Old repositories have core.sharedrepository written in
1132 * numeric format, and therefore these values are preserved for compatibility
1133 * reasons.
1134 */
Junio C Hamano94df2502006-06-10 06:09:49[diff] [blame]1135enum sharedrepo {
Heikki Orsila06cbe852008-04-16 08:34:24[diff] [blame]1136 PERM_UMASK = 0,
1137 OLD_PERM_GROUP = 1,
1138 OLD_PERM_EVERYBODY = 2,
1139 PERM_GROUP = 0660,
Gary V. Vaughan4b055482010-05-14 09:31:35[diff] [blame]1140 PERM_EVERYBODY = 0664
Junio C Hamano94df2502006-06-10 06:09:49[diff] [blame]1141};
1142int git_config_perm(const char *var, const char *value);
Torsten Bögershausen3a429d32013-03-30 09:53:32[diff] [blame]1143int adjust_shared_perm(const char *path);
Michael Haggerty0be05212014-01-06 13:45:25[diff] [blame]1144
1145/*
1146 * Create the directory containing the named path, using care to be
Michael Haggerty204a0472017-01-06 16:22:25[diff] [blame]1147 * somewhat safe against races. Return one of the scld_error values to
1148 * indicate success/failure. On error, set errno to describe the
1149 * problem.
Michael Haggerty18d37e82014-01-06 13:45:27[diff] [blame]1150 *
1151 * SCLD_VANISHED indicates that one of the ancestor directories of the
1152 * path existed at one point during the function call and then
1153 * suddenly vanished, probably because another process pruned the
1154 * directory while we were working. To be robust against this kind of
1155 * race, callers might want to try invoking the function again when it
1156 * returns SCLD_VANISHED.
Michael Haggertye95792e2016-04-24 02:34:12[diff] [blame]1157 *
1158 * safe_create_leading_directories() temporarily changes path while it
1159 * is working but restores it before returning.
1160 * safe_create_leading_directories_const() doesn't modify path, even
1161 * temporarily.
Michael Haggerty0be05212014-01-06 13:45:25[diff] [blame]1162 */
1163enum scld_error {
1164 SCLD_OK = 0,
1165 SCLD_FAILED = -1,
1166 SCLD_PERMS = -2,
Michael Haggerty18d37e82014-01-06 13:45:27[diff] [blame]1167 SCLD_EXISTS = -3,
1168 SCLD_VANISHED = -4
Michael Haggerty0be05212014-01-06 13:45:25[diff] [blame]1169};
1170enum scld_error safe_create_leading_directories(char *path);
1171enum scld_error safe_create_leading_directories_const(const char *path);
1172
Michael Haggerty177978f2017-01-06 16:22:26[diff] [blame]1173/*
1174 * Callback function for raceproof_create_file(). This function is
1175 * expected to do something that makes dirname(path) permanent despite
1176 * the fact that other processes might be cleaning up empty
1177 * directories at the same time. Usually it will create a file named
1178 * path, but alternatively it could create another file in that
1179 * directory, or even chdir() into that directory. The function should
1180 * return 0 if the action was completed successfully. On error, it
1181 * should return a nonzero result and set errno.
1182 * raceproof_create_file() treats two errno values specially:
1183 *
1184 * - ENOENT -- dirname(path) does not exist. In this case,
1185 * raceproof_create_file() tries creating dirname(path)
1186 * (and any parent directories, if necessary) and calls
1187 * the function again.
1188 *
1189 * - EISDIR -- the file already exists and is a directory. In this
1190 * case, raceproof_create_file() removes the directory if
1191 * it is empty (and recursively any empty directories that
1192 * it contains) and calls the function again.
1193 *
1194 * Any other errno causes raceproof_create_file() to fail with the
1195 * callback's return value and errno.
1196 *
1197 * Obviously, this function should be OK with being called again if it
1198 * fails with ENOENT or EISDIR. In other scenarios it will not be
1199 * called again.
1200 */
1201typedef int create_file_fn(const char *path, void *cb);
1202
1203/*
1204 * Create a file in dirname(path) by calling fn, creating leading
1205 * directories if necessary. Retry a few times in case we are racing
1206 * with another process that is trying to clean up the directory that
1207 * contains path. See the documentation for create_file_fn for more
1208 * details.
1209 *
1210 * Return the value and set the errno that resulted from the most
1211 * recent call of fn. fn is always called at least once, and will be
1212 * called more than once if it returns ENOENT or EISDIR.
1213 */
1214int raceproof_create_file(const char *path, create_file_fn fn, void *cb);
1215
Junio C Hamano90a64642011-03-11 00:02:50[diff] [blame]1216int mkdir_in_gitdir(const char *path);
Nguyễn Thái Ngọc Duy4aad2f12017-04-05 10:24:38[diff] [blame]1217extern char *expand_user_path(const char *path, int real_home);
Erik Faye-Lund1c64b482011-10-04 20:02:00[diff] [blame]1218const char *enter_repo(const char *path, int strict);
Johannes Schindeline5392c52007-08-01 00:28:59[diff] [blame]1219static inline int is_absolute_path(const char *path)
1220{
Theo Niessink88135202011-05-27 16:00:38[diff] [blame]1221 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
Johannes Schindeline5392c52007-08-01 00:28:59[diff] [blame]1222}
Junio C Hamano90b4a712008-09-09 08:27:07[diff] [blame]1223int is_directory(const char *);
Brandon Williamsa1ae4842016-12-12 18:16:53[diff] [blame]1224char *strbuf_realpath(struct strbuf *resolved, const char *path,
1225 int die_on_error);
Carlos Martín Nietoe2a57aa2011-03-17 11:26:46[diff] [blame]1226const char *real_path(const char *path);
Michael Haggertye3e46cd2012-10-28 16:16:22[diff] [blame]1227const char *real_path_if_valid(const char *path);
Johannes Schindelince83ead2017-03-08 15:43:40[diff] [blame]1228char *real_pathdup(const char *path, int die_on_error);
Carlos Martín Nietoe2a57aa2011-03-17 11:26:46[diff] [blame]1229const char *absolute_path(const char *path);
René Scharfeb1edb402017-01-26 17:47:45[diff] [blame]1230char *absolute_pathdup(const char *path);
Jiang Xin41894ae2013-10-14 02:29:40[diff] [blame]1231const char *remove_leading_path(const char *in, const char *prefix);
Jiang Xine02ca722013-06-25 15:53:43[diff] [blame]1232const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
Nguyễn Thái Ngọc Duy645a29c2013-07-14 08:36:03[diff] [blame]1233int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
Johannes Sixtf3cad0a2009-02-07 15:08:28[diff] [blame]1234int normalize_path_copy(char *dst, const char *src);
Michael Haggerty31171d92012-10-28 16:16:24[diff] [blame]1235int longest_ancestor_length(const char *path, struct string_list *prefixes);
Johannes Schindelin4fcc86b2009-02-19 19:10:49[diff] [blame]1236char *strip_path_suffix(const char *path, const char *suffix);
Shawn O. Pearce34b6cb82009-11-09 19:26:43[diff] [blame]1237int daemon_avoid_alias(const char *path);
Johannes Schindeline7cb0b42018-05-11 14:03:54[diff] [blame]1238
1239/*
1240 * These functions match their is_hfs_dotgit() counterparts; see utf8.h for
1241 * details.
1242 */
1243int is_ntfs_dotgit(const char *name);
1244int is_ntfs_dotgitmodules(const char *name);
1245int is_ntfs_dotgitignore(const char *name);
1246int is_ntfs_dotgitattributes(const char *name);
Junio C Hamanob2cb9422005-07-06 08:11:52[diff] [blame]1247
Jeff King2491f772017-07-28 19:25:45[diff] [blame]1248/*
1249 * Returns true iff "str" could be confused as a command-line option when
1250 * passed to a sub-program like "ssh". Note that this has nothing to do with
1251 * shell-quoting, which should be handled separately; we're assuming here that
1252 * the string makes it verbatim to the sub-program.
1253 */
1254int looks_like_command_line_option(const char *str);
1255
Paul Tanea192892015-04-21 04:06:27[diff] [blame]1256/**
1257 * Return a newly allocated string with the evaluation of
1258 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1259 * "$HOME/.config/git/$filename". Return NULL upon error.
1260 */
1261extern char *xdg_config_home(const char *filename);
1262
Devin Lehmachere7f136b2017-03-13 20:43:54[diff] [blame]1263/**
1264 * Return a newly allocated string with the evaluation of
1265 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
1266 * "$HOME/.cache/git/$filename". Return NULL upon error.
1267 */
1268extern char *xdg_cache_home(const char *filename);
1269
Junio C Hamano1b8ac5e2016-10-28 13:23:07[diff] [blame]1270extern int git_open_cloexec(const char *name, int flags);
Junio C Hamanob4d065d2016-10-28 13:29:27[diff] [blame]1271#define git_open(name) git_open_cloexec(name, O_RDONLY)
Junio C Hamanoeb4f4072011-07-19 16:33:03[diff] [blame]1272extern 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:10[diff] [blame]1273extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
Daniel Barkalow8237b182005-04-24 01:47:23[diff] [blame]1274
brian m. carlson17e65452018-03-12 02:27:39[diff] [blame]1275extern int check_object_signature(const struct object_id *oid, void *buf, unsigned long size, const char *type);
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]1276
Junio C Hamanocb5add52015-08-07 21:40:24[diff] [blame]1277extern int finalize_object_file(const char *tmpfile, const char *filename);
Daniel Barkalow8237b182005-04-24 01:47:23[diff] [blame]1278
Christian Couder6a5e6f52017-02-27 18:00:11[diff] [blame]1279/* Helper to check and "touch" a file */
1280extern int check_and_freshen_file(const char *fn, int freshen);
1281
Linus Torvalds192a6be2007-05-30 17:32:19[diff] [blame]1282extern const signed char hexval_table[256];
1283static inline unsigned int hexval(unsigned char c)
Junio C Hamanoe49521b2006-09-20 23:04:46[diff] [blame]1284{
1285 return hexval_table[c];
1286}
1287
René Scharfed2330972016-09-03 15:59:20[diff] [blame]1288/*
1289 * Convert two consecutive hexadecimal digits into a char. Return a
1290 * negative value on error. Don't run over the end of short strings.
1291 */
1292static inline int hex2chr(const char *s)
1293{
Ramsay Jones356a2932017-09-21 16:48:38[diff] [blame]1294 unsigned int val = hexval(s[0]);
1295 return (val & ~0xf) ? val : (val << 4) | hexval(s[1]);
René Scharfed2330972016-09-03 15:59:20[diff] [blame]1296}
1297
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]1298/* Convert to/from hex/sha1 representation */
Linus Torvaldsdce96482010-10-28 18:28:04[diff] [blame]1299#define MINIMUM_ABBREV minimum_abbrev
1300#define DEFAULT_ABBREV default_abbrev
Junio C Hamano46a6c262006-01-25 09:03:18[diff] [blame]1301
Junio C Hamano65acfea2016-10-01 00:19:35[diff] [blame]1302/* used when the code does not know or care what the default abbrev is */
1303#define FALLBACK_DEFAULT_ABBREV 7
1304
Clément Poulain573285e2010-06-09 17:02:06[diff] [blame]1305struct object_context {
Clément Poulain573285e2010-06-09 17:02:06[diff] [blame]1306 unsigned mode;
David Turnerc4ec9672015-05-20 17:03:39[diff] [blame]1307 /*
1308 * symlink_path is only used by get_tree_entry_follow_symlinks,
1309 * and only for symlinks that point outside the repository.
1310 */
1311 struct strbuf symlink_path;
Jeff Kingdc944b62017-05-19 12:54:43[diff] [blame]1312 /*
brian m. carlson321c89b2017-07-13 23:49:29[diff] [blame]1313 * If GET_OID_RECORD_PATH is set, this will record path (if any)
Jeff Kingdc944b62017-05-19 12:54:43[diff] [blame]1314 * found when resolving the name. The caller is responsible for
1315 * releasing the memory.
1316 */
1317 char *path;
Clément Poulain573285e2010-06-09 17:02:06[diff] [blame]1318};
1319
brian m. carlson321c89b2017-07-13 23:49:29[diff] [blame]1320#define GET_OID_QUIETLY 01
1321#define GET_OID_COMMIT 02
1322#define GET_OID_COMMITTISH 04
1323#define GET_OID_TREE 010
1324#define GET_OID_TREEISH 020
1325#define GET_OID_BLOB 040
1326#define GET_OID_FOLLOW_SYMLINKS 0100
1327#define GET_OID_RECORD_PATH 0200
1328#define GET_OID_ONLY_TO_DIE 04000
Junio C Hamano37c00e52012-06-18 18:32:03[diff] [blame]1329
brian m. carlson321c89b2017-07-13 23:49:29[diff] [blame]1330#define GET_OID_DISAMBIGUATORS \
1331 (GET_OID_COMMIT | GET_OID_COMMITTISH | \
1332 GET_OID_TREE | GET_OID_TREEISH | \
1333 GET_OID_BLOB)
Michael Haggertyd4e85a12011-09-23 13:38:36[diff] [blame]1334
brian m. carlson2764fd92016-04-17 23:10:36[diff] [blame]1335extern int get_oid(const char *str, struct object_id *oid);
brian m. carlsone82caf32017-07-13 23:49:28[diff] [blame]1336extern int get_oid_commit(const char *str, struct object_id *oid);
1337extern int get_oid_committish(const char *str, struct object_id *oid);
1338extern int get_oid_tree(const char *str, struct object_id *oid);
1339extern int get_oid_treeish(const char *str, struct object_id *oid);
1340extern int get_oid_blob(const char *str, struct object_id *oid);
1341extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1342extern int get_oid_with_context(const char *str, unsigned flags, struct object_id *oid, struct object_context *oc);
1343
brian m. carlson2764fd92016-04-17 23:10:36[diff] [blame]1344
brian m. carlson1b7ba792017-03-31 01:39:59[diff] [blame]1345typedef int each_abbrev_fn(const struct object_id *oid, void *);
Junio C Hamano957d7402012-07-03 21:21:59[diff] [blame]1346extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
Michael Haggertyd4e85a12011-09-23 13:38:36[diff] [blame]1347
Jeff King5b33cb12016-09-27 12:38:01[diff] [blame]1348extern int set_disambiguate_hint_config(const char *var, const char *value);
1349
Michael Haggertyd4e85a12011-09-23 13:38:36[diff] [blame]1350/*
1351 * Try to read a SHA1 in hexadecimal format from the 40 characters
1352 * starting at hex. Write the 20-byte result to sha1 in binary form.
1353 * Return 0 on success. Reading stops if a NUL is encountered in the
1354 * input, so it is safe to pass this function an arbitrary
1355 * null-terminated string.
1356 */
Linus Torvalds197ee8c2005-04-09 19:09:27[diff] [blame]1357extern int get_sha1_hex(const char *hex, unsigned char *sha1);
brian m. carlsonaa1c6fd2015-03-13 23:39:28[diff] [blame]1358extern int get_oid_hex(const char *hex, struct object_id *sha1);
Michael Haggertyd4e85a12011-09-23 13:38:36[diff] [blame]1359
Jeff Kingaf49c6d2015-09-24 21:05:45[diff] [blame]1360/*
René Scharfe0ec21862017-10-31 13:46:49[diff] [blame]1361 * Read `len` pairs of hexadecimal digits from `hex` and write the
1362 * values to `binary` as `len` bytes. Return 0 on success, or -1 if
1363 * the input does not consist of hex digits).
1364 */
1365extern int hex_to_bytes(unsigned char *binary, const char *hex, size_t len);
1366
1367/*
Jeff Kingaf49c6d2015-09-24 21:05:45[diff] [blame]1368 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1369 * and writes the NUL-terminated output to the buffer `out`, which must be at
1370 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1371 * convenience.
1372 *
1373 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1374 * buffers, making it safe to make multiple calls for a single statement, like:
1375 *
1376 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1377 */
1378extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
brian m. carlson55c529a2016-06-24 23:09:19[diff] [blame]1379extern char *oid_to_hex_r(char *out, const struct object_id *oid);
Linus Torvalds197ee8c2005-04-09 19:09:27[diff] [blame]1380extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
brian m. carlsonaa1c6fd2015-03-13 23:39:28[diff] [blame]1381extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
Michael Haggerty7cb36842011-09-15 21:10:42[diff] [blame]1382
Jeff Kinge322b602017-03-02 08:21:23[diff] [blame]1383/*
brian m. carlson605f4302017-02-20 00:10:13[diff] [blame]1384 * Parse a 40-character hexadecimal object ID starting from hex, updating the
1385 * pointer specified by end when parsing stops. The resulting object ID is
1386 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or
1387 * other invalid character. end is only updated on success; otherwise, it is
1388 * unmodified.
1389 */
1390extern int parse_oid_hex(const char *hex, struct object_id *oid, const char **end);
1391
Junio C Hamanoe1fae932017-03-17 20:50:24[diff] [blame]1392/*
Jeff Kinge322b602017-03-02 08:21:23[diff] [blame]1393 * This reads short-hand syntax that not only evaluates to a commit
1394 * object name, but also can act as if the end user spelled the name
1395 * of the branch from the command line.
1396 *
1397 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1398 * places the name of the branch in the given buf and returns the
1399 * number of characters parsed if successful.
1400 *
1401 * - "<branch>@{upstream}" finds the name of the other ref that
1402 * <branch> is configured to merge with (missing <branch> defaults
1403 * to the current branch), and places the name of the branch in the
1404 * given buf and returns the number of characters parsed if
1405 * successful.
1406 *
1407 * If the input is not of the accepted format, it returns a negative
1408 * number to signal an error.
1409 *
1410 * If the input was ok but there are not N branch switches in the
1411 * reflog, it returns 0.
Jeff King0e9f62d2017-03-02 08:23:01[diff] [blame]1412 *
1413 * If "allowed" is non-zero, it is a treated as a bitfield of allowable
1414 * expansions: local branches ("refs/heads/"), remote branches
1415 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
1416 * allowed, even ones to refs outside of those namespaces.
Jeff Kinge322b602017-03-02 08:21:23[diff] [blame]1417 */
Jeff King0e9f62d2017-03-02 08:23:01[diff] [blame]1418#define INTERPRET_BRANCH_LOCAL (1<<0)
1419#define INTERPRET_BRANCH_REMOTE (1<<1)
1420#define INTERPRET_BRANCH_HEAD (1<<2)
1421extern int interpret_branch_name(const char *str, int len, struct strbuf *,
1422 unsigned allowed);
brian m. carlson151b2912016-09-05 20:08:07[diff] [blame]1423extern int get_oid_mb(const char *str, struct object_id *oid);
Junio C Hamanoe86eb662007-01-19 09:15:15[diff] [blame]1424
Junio C Hamanoc847f532007-01-02 07:31:08[diff] [blame]1425extern int validate_headref(const char *ref);
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]1426
Linus Torvalds958ba6c2005-05-20 16:09:18[diff] [blame]1427extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
Linus Torvalds0ab9e1e2008-03-06 02:25:10[diff] [blame]1428extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
Jeremiah Mahlerccdd4a02014-06-20 02:06:44[diff] [blame]1429extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
Thomas Gummererb60e1882012-07-11 09:22:37[diff] [blame]1430extern 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:13[diff] [blame]1431
brian m. carlson02f05472018-03-12 02:27:52[diff] [blame]1432extern void *read_object_with_reference(const struct object_id *oid,
Brian Gerstbf0f9102005-05-18 12:14:09[diff] [blame]1433 const char *required_type,
Junio C Hamano40469ee2005-04-28 23:42:27[diff] [blame]1434 unsigned long *size,
brian m. carlson02f05472018-03-12 02:27:52[diff] [blame]1435 struct object_id *oid_ret);
Junio C Hamanof4913f92005-04-21 01:06:49[diff] [blame]1436
Junio C Hamano81776312007-12-24 08:51:01[diff] [blame]1437extern struct object *peel_to_type(const char *name, int namelen,
1438 struct object *o, enum object_type);
1439
Johannes Schindelin58930fd2018-07-30 15:42:49[diff] [blame]1440enum date_mode_type {
1441 DATE_NORMAL = 0,
1442 DATE_RELATIVE,
1443 DATE_SHORT,
1444 DATE_ISO8601,
1445 DATE_ISO8601_STRICT,
1446 DATE_RFC2822,
1447 DATE_STRFTIME,
1448 DATE_RAW,
1449 DATE_UNIX
1450};
1451
Jeff Kinga5481a62015-06-25 16:55:02[diff] [blame]1452struct date_mode {
Johannes Schindelin58930fd2018-07-30 15:42:49[diff] [blame]1453 enum date_mode_type type;
Jeff Kingaa1462c2015-06-25 16:55:45[diff] [blame]1454 const char *strftime_fmt;
Jeff Kingadd00ba2015-09-03 21:48:59[diff] [blame]1455 int local;
Junio C Hamano73013af2007-07-14 06:14:52[diff] [blame]1456};
1457
Jeff Kinga5481a62015-06-25 16:55:02[diff] [blame]1458/*
1459 * Convenience helper for passing a constant type, like:
1460 *
1461 * show_date(t, tz, DATE_MODE(NORMAL));
1462 */
1463#define DATE_MODE(t) date_mode_from_type(DATE_##t)
1464struct date_mode *date_mode_from_type(enum date_mode_type type);
1465
Johannes Schindelindddbad72017-04-26 19:29:31[diff] [blame]1466const char *show_date(timestamp_t time, int timezone, const struct date_mode *mode);
1467void show_date_relative(timestamp_t time, int tz, const struct timeval *now,
Jonathan Nieder7d29afd2012-04-23 12:30:23[diff] [blame]1468 struct strbuf *timebuf);
Jeff Kingc33ddc22014-08-27 07:57:08[diff] [blame]1469int parse_date(const char *date, struct strbuf *out);
Johannes Schindelindddbad72017-04-26 19:29:31[diff] [blame]1470int parse_date_basic(const char *date, timestamp_t *timestamp, int *offset);
1471int parse_expiry_date(const char *date, timestamp_t *timestamp);
Jeff Kingc33ddc22014-08-27 07:57:08[diff] [blame]1472void datestamp(struct strbuf *out);
Junio C Hamano93cfa7c2010-01-26 19:58:00[diff] [blame]1473#define approxidate(s) approxidate_careful((s), NULL)
Johannes Schindelindddbad72017-04-26 19:29:31[diff] [blame]1474timestamp_t approxidate_careful(const char *, int *);
1475timestamp_t approxidate_relative(const char *date, const struct timeval *now);
Jeff Kinga5481a62015-06-25 16:55:02[diff] [blame]1476void parse_date_format(const char *format, struct date_mode *mode);
Johannes Schindelindddbad72017-04-26 19:29:31[diff] [blame]1477int date_overflows(timestamp_t date);
Edgar Toernigecee9d92005-04-30 16:46:49[diff] [blame]1478
Jeff Kingf9bc5732012-05-24 23:28:40[diff] [blame]1479#define IDENT_STRICT 1
Jeff Kingb9f0ac12012-05-21 23:10:11[diff] [blame]1480#define IDENT_NO_DATE 2
Jeff Kingc15e1982012-05-24 23:27:24[diff] [blame]1481#define IDENT_NO_NAME 4
Junio C Hamano749be722006-02-19 04:31:05[diff] [blame]1482extern const char *git_author_info(int);
1483extern const char *git_committer_info(int);
Junio C Hamano798123a2007-02-05 01:50:14[diff] [blame]1484extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
Junio C Hamanod9ccfe72007-12-02 21:43:34[diff] [blame]1485extern const char *fmt_name(const char *name, const char *email);
Matthieu Moy98305342014-07-25 19:11:34[diff] [blame]1486extern const char *ident_default_name(void);
Jeff Kingbcb2b002012-05-21 23:09:43[diff] [blame]1487extern const char *ident_default_email(void);
Jonathan Nieder44fcb492009-11-12 00:01:27[diff] [blame]1488extern const char *git_editor(void);
Alban Gruin2aed0182018-08-10 16:51:30[diff] [blame]1489extern const char *git_sequence_editor(void);
Jonathan Nieder64778d22010-02-14 11:59:59[diff] [blame]1490extern const char *git_pager(int stdout_is_tty);
Lars Schneidera64f2132017-11-29 14:37:51[diff] [blame]1491extern int is_terminal_dumb(void);
Jeff King95979212012-05-21 23:09:54[diff] [blame]1492extern int git_ident_config(const char *, const char *, void *);
Jeff King4d9c7e62016-08-01 19:37:00[diff] [blame]1493extern void reset_ident_date(void);
Linus Torvalds6aa33f42005-07-12 18:49:27[diff] [blame]1494
Junio C Hamano4b340cf2012-03-11 09:25:43[diff] [blame]1495struct ident_split {
1496 const char *name_begin;
1497 const char *name_end;
1498 const char *mail_begin;
1499 const char *mail_end;
1500 const char *date_begin;
1501 const char *date_end;
1502 const char *tz_begin;
1503 const char *tz_end;
1504};
1505/*
1506 * Signals an success with 0, but time part of the result may be NULL
1507 * if the input lacks timestamp and zone
1508 */
1509extern int split_ident_line(struct ident_split *, const char *, int);
1510
Jeff King662cc302013-09-20 10:16:28[diff] [blame]1511/*
Jeff Kingd1053242014-05-02 01:07:22[diff] [blame]1512 * Like show_date, but pull the timestamp and tz parameters from
1513 * the ident_split. It will also sanity-check the values and produce
1514 * a well-known sentinel date if they appear bogus.
1515 */
Jeff Kinga5481a62015-06-25 16:55:02[diff] [blame]1516const char *show_ident_date(const struct ident_split *id,
1517 const struct date_mode *mode);
Jeff Kingd1053242014-05-02 01:07:22[diff] [blame]1518
1519/*
Jeff King662cc302013-09-20 10:16:28[diff] [blame]1520 * Compare split idents for equality or strict ordering. Note that we
1521 * compare only the ident part of the line, ignoring any timestamp.
1522 *
1523 * Because there are two fields, we must choose one as the primary key; we
1524 * currently arbitrarily pick the email.
1525 */
1526extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1527
Linus Torvalds12dccc12005-06-06 04:59:54[diff] [blame]1528struct checkout {
Nguyễn Thái Ngọc Duyd4a20242014-06-13 12:19:34[diff] [blame]1529 struct index_state *istate;
Linus Torvalds12dccc12005-06-06 04:59:54[diff] [blame]1530 const char *base_dir;
1531 int base_dir_len;
Lars Schneider2841e8f2017-06-30 20:41:28[diff] [blame]1532 struct delayed_checkout *delayed_checkout;
Linus Torvalds12dccc12005-06-06 04:59:54[diff] [blame]1533 unsigned force:1,
1534 quiet:1,
1535 not_new:1,
Duy Nguyenb8785792018-08-17 18:00:39[diff] [blame]1536 clone:1,
Linus Torvalds12dccc12005-06-06 04:59:54[diff] [blame]1537 refresh_cache:1;
1538};
René Scharfe68e3d622016-09-22 16:11:33[diff] [blame]1539#define CHECKOUT_INIT { NULL, "" }
Linus Torvalds12dccc12005-06-06 04:59:54[diff] [blame]1540
Junio C Hamanoaf2a6512013-10-23 17:52:42[diff] [blame]1541#define TEMPORARY_FILENAME_LENGTH 25
Luiz Fernando N. Capitulinoefbc5832007-04-25 14:18:08[diff] [blame]1542extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
Lars Schneider2841e8f2017-06-30 20:41:28[diff] [blame]1543extern void enable_delayed_checkout(struct checkout *state);
1544extern int finish_delayed_checkout(struct checkout *state);
Linus Torvaldsb9fd2842009-07-09 20:35:31[diff] [blame]1545
1546struct cache_def {
Karsten Bleese7c73052014-07-04 22:41:46[diff] [blame]1547 struct strbuf path;
Linus Torvaldsb9fd2842009-07-09 20:35:31[diff] [blame]1548 int flags;
1549 int track_flags;
1550 int prefix_len_stat_func;
1551};
Karsten Bleese7c73052014-07-04 22:41:46[diff] [blame]1552#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
Karsten Blees2a608392014-07-11 23:02:34[diff] [blame]1553static inline void cache_def_clear(struct cache_def *cache)
Karsten Bleese7c73052014-07-04 22:41:46[diff] [blame]1554{
1555 strbuf_release(&cache->path);
1556}
Linus Torvaldsb9fd2842009-07-09 20:35:31[diff] [blame]1557
Kjetil Barvik57199892009-02-09 20:54:06[diff] [blame]1558extern int has_symlink_leading_path(const char *name, int len);
Linus Torvaldsb9fd2842009-07-09 20:35:31[diff] [blame]1559extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
Clemens Buchacherf66caaf2010-10-09 13:53:00[diff] [blame]1560extern int check_leading_path(const char *name, int len);
Kjetil Barvik57199892009-02-09 20:54:06[diff] [blame]1561extern int has_dirs_only_path(const char *name, int len, int prefix_len);
Kjetil Barvik78478922009-02-09 20:54:07[diff] [blame]1562extern void schedule_dir_for_removal(const char *name, int len);
1563extern void remove_scheduled_dirs(void);
Linus Torvalds12dccc12005-06-06 04:59:54[diff] [blame]1564
Shawn O. Pearcec41ee582006-12-23 07:33:44[diff] [blame]1565struct pack_window {
1566 struct pack_window *next;
1567 unsigned char *base;
1568 off_t offset;
1569 size_t len;
1570 unsigned int last_used;
1571 unsigned int inuse_cnt;
1572};
1573
Junio C Hamanof3bf9222005-07-01 00:15:39[diff] [blame]1574struct pack_entry {
Shawn O. Pearcec4001d92007-03-07 01:44:30[diff] [blame]1575 off_t offset;
Junio C Hamanof3bf9222005-07-01 00:15:39[diff] [blame]1576 struct packed_git *p;
1577};
1578
Michael Haggertyd40d5352014-02-21 16:32:06[diff] [blame]1579/*
Jeff King892e7232017-03-28 19:45:25[diff] [blame]1580 * Create a temporary file rooted in the object database directory, or
1581 * die on failure. The filename is taken from "pattern", which should have the
1582 * usual "XXXXXX" trailer, and the resulting filename is written into the
1583 * "template" buffer. Returns the open descriptor.
Jeff King82c9d662017-03-16 14:27:00[diff] [blame]1584 */
Brandon Williamsa63b5fc2018-02-14 18:59:53[diff] [blame]1585extern int odb_mkstemp(struct strbuf *temp_filename, const char *pattern);
Jeff King82c9d662017-03-16 14:27:00[diff] [blame]1586
1587/*
Jeff Kingeaeefc32017-03-16 14:27:12[diff] [blame]1588 * Create a pack .keep file named "name" (which should generally be the output
1589 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1590 * error.
Jeff King82c9d662017-03-16 14:27:00[diff] [blame]1591 */
Jeff Kingeaeefc32017-03-16 14:27:12[diff] [blame]1592extern int odb_pack_keep(const char *name);
Jeff King82c9d662017-03-16 14:27:00[diff] [blame]1593
1594/*
Jonathan Tan8b4c0102017-12-08 15:27:14[diff] [blame]1595 * Set this to 0 to prevent sha1_object_info_extended() from fetching missing
1596 * blobs. This has a difference only if extensions.partialClone is set.
1597 *
1598 * Its default value is 1.
1599 */
1600extern int fetch_if_missing;
1601
Junio C Hamano8f3f9b02005-07-24 00:54:41[diff] [blame]1602/* Dumb servers support */
1603extern int update_server_info(int);
1604
Pat Notza6fa5992010-11-02 19:59:07[diff] [blame]1605extern const char *get_log_output_encoding(void);
1606extern const char *get_commit_output_encoding(void);
1607
Christian Couderdae6c322016-01-27 06:58:06[diff] [blame]1608/*
1609 * This is a hack for test programs like test-dump-untracked-cache to
1610 * ensure that they do not modify the untracked cache when reading it.
1611 * Do not use it otherwise!
1612 */
1613extern int ignore_untracked_cache_config;
Matthias Lederhoferaa086eb2006-07-29 22:27:43[diff] [blame]1614
Jeff Kingd6991ce2012-11-15 00:34:13[diff] [blame]1615extern int committer_ident_sufficiently_given(void);
Linus Torvaldse1b10392005-10-12 01:47:34[diff] [blame]1616extern int author_ident_sufficiently_given(void);
Shawn O. Pearce1a8f2742007-03-12 19:33:18[diff] [blame]1617
Shawn O. Pearce3a556022007-03-07 01:44:17[diff] [blame]1618extern const char *git_commit_encoding;
Marius Storm-Olsend551a482009-02-08 14:34:27[diff] [blame]1619extern const char *git_log_output_encoding;
Junio C Hamano4e72dce2005-11-28 00:09:40[diff] [blame]1620extern const char *git_mailmap_file;
Theodore Ts'o06f59e92007-06-29 17:40:46[diff] [blame]1621extern const char *git_mailmap_blob;
1622
Junio C Hamanof3123c42005-10-22 08:28:13[diff] [blame]1623/* IO helper functions */
Daniel Barkalow1468bd42008-02-25 19:24:48[diff] [blame]1624extern void maybe_flush_or_die(FILE *, const char *);
Jeff King9540ce52014-09-10 10:03:52[diff] [blame]1625__attribute__((format (printf, 2, 3)))
1626extern void fprintf_or_die(FILE *, const char *fmt, ...);
Junio C Hamano00b7cbf2015-05-19 17:55:16[diff] [blame]1627
1628#define COPY_READ_ERROR (-2)
1629#define COPY_WRITE_ERROR (-3)
Daniel Barkalow1468bd42008-02-25 19:24:48[diff] [blame]1630extern int copy_fd(int ifd, int ofd);
Clemens Buchacherf7835a22009-09-12 09:03:48[diff] [blame]1631extern int copy_file(const char *dst, const char *src, int mode);
Rene Scharfe7230e6d2006-08-21 18:43:43[diff] [blame]1632extern int copy_file_with_time(const char *dst, const char *src, int mode);
Junio C Hamano00b7cbf2015-05-19 17:55:16[diff] [blame]1633
Christian Couder6ce4e612006-09-02 16:23:48[diff] [blame]1634extern void write_or_die(int fd, const void *buf, size_t count);
Junio C Hamanoad897212005-12-15 06:17:38[diff] [blame]1635extern void fsync_or_die(int fd, const char *);
Jim Meyering2b7ca832009-09-12 08:54:32[diff] [blame]1636
1637extern ssize_t read_in_full(int fd, void *buf, size_t count);
1638extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1639extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1640
1641static inline ssize_t write_str_in_full(int fd, const char *str)
1642{
Linus Torvaldsf67b45f2006-02-28 19:26:21[diff] [blame]1643 return write_in_full(fd, str, strlen(str));
1644}
Junio C Hamano12d6ce12015-08-24 20:03:07[diff] [blame]1645
Jeff King52563d72016-07-08 09:12:22[diff] [blame]1646/**
1647 * Open (and truncate) the file at path, write the contents of buf to it,
1648 * and close it. Dies if any errors are encountered.
1649 */
1650extern void write_file_buf(const char *path, const char *buf, size_t len);
1651
Jeff Kinge04d08a2016-07-08 09:12:42[diff] [blame]1652/**
1653 * Like write_file_buf(), but format the contents into a buffer first.
1654 * Additionally, write_file() will append a newline if one is not already
1655 * present, making it convenient to write text files:
1656 *
1657 * write_file(path, "counter: %d", ctr);
1658 */
1659__attribute__((format (printf, 2, 3)))
Jeff Kingef223182016-07-08 09:09:34[diff] [blame]1660extern void write_file(const char *path, const char *fmt, ...);
Jim Meyering2b7ca832009-09-12 08:54:32[diff] [blame]1661
Linus Torvaldsf67b45f2006-02-28 19:26:21[diff] [blame]1662/* pager.c */
1663extern void setup_pager(void);
Jeff King6e9af862007-12-11 06:27:33[diff] [blame]1664extern int pager_in_use(void);
Matthias Lederhoferaa086eb2006-07-29 22:27:43[diff] [blame]1665extern int pager_use_color;
Zbigniew Jędrzejewski-Szmekad6c3732012-02-12 14:12:32[diff] [blame]1666extern int term_columns(void);
Jeff Kingd306f3d2015-02-05 08:14:19[diff] [blame]1667extern int decimal_width(uintmax_t);
Nguyễn Thái Ngọc Duy4914c962012-10-26 15:53:52[diff] [blame]1668extern int check_pager_config(const char *cmd);
Junio C Hamano3e3a4a42016-02-16 22:34:44[diff] [blame]1669extern void prepare_pager_args(struct child_process *, const char *pager);
Linus Torvaldsf67b45f2006-02-28 19:26:21[diff] [blame]1670
Christian Couderee9601e2008-02-16 05:01:41[diff] [blame]1671extern const char *editor_program;
Anselm Kruisd3e7da82010-08-30 13:38:38[diff] [blame]1672extern const char *askpass_program;
Christian Couderdfb068b2008-02-16 05:01:59[diff] [blame]1673extern const char *excludes_file;
Johannes Schindelin4d87b9c2007-07-20 12:06:09[diff] [blame]1674
Junio C Hamano051308f2006-05-04 23:51:44[diff] [blame]1675/* base85 */
Jim Meyeringf9815772007-04-09 22:56:33[diff] [blame]1676int decode_85(char *dst, const char *line, int linelen);
1677void encode_85(char *buf, const unsigned char *data, int bytes);
Junio C Hamano051308f2006-05-04 23:51:44[diff] [blame]1678
Karsten Blees5991a552014-06-11 07:56:49[diff] [blame]1679/* pkt-line.c */
Jeff Kingbbc30f92011-02-24 14:30:19[diff] [blame]1680void packet_trace_identity(const char *prog);
Christian Couder6ce4e612006-09-02 16:23:48[diff] [blame]1681
Junio C Hamanob6ec1d62007-11-18 09:12:04[diff] [blame]1682/* add */
Alex Riesen7ae02a32008-05-12 17:58:10[diff] [blame]1683/*
1684 * return 0 if success, 1 - if addition of a file failed and
1685 * ADD_FILES_IGNORE_ERRORS was specified in flags
1686 */
Thomas Gummerer610d55a2016-09-14 21:07:47[diff] [blame]1687int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
Junio C Hamanob6ec1d62007-11-18 09:12:04[diff] [blame]1688
Junio C Hamanoaecbf912007-08-31 20:13:42[diff] [blame]1689/* diff.c */
1690extern int diff_auto_refresh_index;
1691
Junio C Hamano68faf682007-02-16 00:32:45[diff] [blame]1692/* match-trees.c */
brian m. carlson82db3d42016-04-17 23:10:38[diff] [blame]1693void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);
1694void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);
Junio C Hamano68faf682007-02-16 00:32:45[diff] [blame]1695
Junio C Hamanoa9cc8572007-11-02 07:24:27[diff] [blame]1696/*
1697 * whitespace rules.
1698 * used by both diff and apply
Johannes Sixtf4b05a42010-11-30 08:29:11[diff] [blame]1699 * last two digits are tab width
Junio C Hamanoa9cc8572007-11-02 07:24:27[diff] [blame]1700 */
Johannes Sixtf4b05a42010-11-30 08:29:11[diff] [blame]1701#define WS_BLANK_AT_EOL 0100
1702#define WS_SPACE_BEFORE_TAB 0200
1703#define WS_INDENT_WITH_NON_TAB 0400
1704#define WS_CR_AT_EOL 01000
1705#define WS_BLANK_AT_EOF 02000
1706#define WS_TAB_IN_INDENT 04000
Junio C Hamanoaeb84b02009-09-06 05:21:17[diff] [blame]1707#define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
Johannes Sixtf4b05a42010-11-30 08:29:11[diff] [blame]1708#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1709#define WS_TAB_WIDTH_MASK 077
Stefan Beller091f8e22017-06-30 00:06:53[diff] [blame]1710/* All WS_* -- when extended, adapt diff.c emit_symbol */
1711#define WS_RULE_MASK 07777
Junio C Hamanocf1b7862007-12-06 08:14:14[diff] [blame]1712extern unsigned whitespace_rule_cfg;
Nguyễn Thái Ngọc Duy26d024e2018-09-21 15:57:37[diff] [blame]1713extern unsigned whitespace_rule(struct index_state *, const char *);
Junio C Hamanocf1b7862007-12-06 08:14:14[diff] [blame]1714extern unsigned parse_whitespace_rule(const char *);
Junio C Hamano8f8841e2008-06-26 22:35:21[diff] [blame]1715extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1716extern 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:29[diff] [blame]1717extern char *whitespace_error_string(unsigned ws);
Chris Webbd511bd32010-04-02 23:37:23[diff] [blame]1718extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
Junio C Hamano877f23c2008-06-26 22:36:59[diff] [blame]1719extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
Johannes Sixtf4b05a42010-11-30 08:29:11[diff] [blame]1720#define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
Junio C Hamanoa9cc8572007-11-02 07:24:27[diff] [blame]1721
Junio C Hamanoee425e42007-11-18 09:13:32[diff] [blame]1722/* ls-files */
Brandon Williams312c9842017-06-12 22:13:58[diff] [blame]1723void overlay_tree_on_index(struct index_state *istate,
1724 const char *tree_name, const char *prefix);
Junio C Hamanoee425e42007-11-18 09:13:32[diff] [blame]1725
Jeff King46c3cd42016-03-05 22:10:27[diff] [blame]1726/* setup.c */
Nguyễn Thái Ngọc Duye37c1322010-08-06 02:40:35[diff] [blame]1727struct startup_info {
Nguyễn Thái Ngọc Duya60645f2010-08-06 02:46:33[diff] [blame]1728 int have_repository;
Nguyễn Thái Ngọc Duyf07d6a12010-12-01 23:33:22[diff] [blame]1729 const char *prefix;
Nguyễn Thái Ngọc Duye37c1322010-08-06 02:40:35[diff] [blame]1730};
1731extern struct startup_info *startup_info;
1732
Nguyễn Thái Ngọc Duydb699a82012-10-26 15:53:49[diff] [blame]1733/* merge.c */
1734struct commit_list;
Nguyễn Thái Ngọc Duy7e196c32018-09-21 15:57:29[diff] [blame]1735int try_merge_command(struct repository *r,
1736 const char *strategy, size_t xopts_nr,
Nguyễn Thái Ngọc Duydb699a82012-10-26 15:53:49[diff] [blame]1737 const char **xopts, struct commit_list *common,
1738 const char *head_arg, struct commit_list *remotes);
Nguyễn Thái Ngọc Duy7e196c32018-09-21 15:57:29[diff] [blame]1739int checkout_fast_forward(struct repository *r,
1740 const struct object_id *from,
brian m. carlsonf06e90d2017-05-06 22:10:33[diff] [blame]1741 const struct object_id *to,
Nguyễn Thái Ngọc Duydb699a82012-10-26 15:53:49[diff] [blame]1742 int overwrite_ignore);
1743
Junio C Hamanocac42b22010-03-06 20:34:41[diff] [blame]1744
Jeff King38f865c2012-03-30 07:52:18[diff] [blame]1745int sane_execvp(const char *file, char *const argv[]);
1746
Michael Haggerty38612532013-06-20 08:37:51[diff] [blame]1747/*
1748 * A struct to encapsulate the concept of whether a file has changed
1749 * since we last checked it. This uses criteria similar to those used
1750 * for the index.
1751 */
1752struct stat_validity {
1753 struct stat_data *sd;
1754};
1755
1756void stat_validity_clear(struct stat_validity *sv);
1757
1758/*
1759 * Returns 1 if the path is a regular file (or a symlink to a regular
1760 * file) and matches the saved stat_validity, 0 otherwise. A missing
1761 * or inaccessible file is considered a match if the struct was just
1762 * initialized, or if the previous update found an inaccessible file.
1763 */
1764int stat_validity_check(struct stat_validity *sv, const char *path);
1765
1766/*
1767 * Update the stat_validity from a file opened at descriptor fd. If
1768 * the file is missing, inaccessible, or not a regular file, then
1769 * future calls to stat_validity_check will match iff one of those
1770 * conditions continues to be true.
1771 */
1772void stat_validity_update(struct stat_validity *sv, int fd);
1773
Nguyễn Thái Ngọc Duy9ef176b2014-02-27 12:56:52[diff] [blame]1774int versioncmp(const char *s1, const char *s2);
Johannes Sixt2024d312015-06-05 19:45:05[diff] [blame]1775void sleep_millisec(int millisec);
Nguyễn Thái Ngọc Duy9ef176b2014-02-27 12:56:52[diff] [blame]1776
David Turnereb338762015-11-10 11:42:38[diff] [blame]1777/*
1778 * Create a directory and (if share is nonzero) adjust its permissions
1779 * according to the shared_repository setting. Only use this for
1780 * directories under $GIT_DIR. Don't use it for working tree
1781 * directories.
1782 */
1783void safe_create_dir(const char *dir, int share);
1784
Ann T Ropeaa2cd7092017-12-03 21:27:39[diff] [blame]1785/*
1786 * Should we print an ellipsis after an abbreviated SHA-1 value
1787 * when doing diff-raw output or indicating a detached HEAD?
1788 */
1789extern int print_sha1_ellipsis(void);
1790
Linus Torvaldse83c5162005-04-07 22:13:13[diff] [blame]1791#endif /* CACHE_H */