Merge branch 'nd/init-core-worktree-in-multi-worktree-world'
[git/git.git] / cache.h
1 #ifndef CACHE_H
2 #define CACHE_H
3
4 #include "git-compat-util.h"
5 #include "strbuf.h"
6 #include "hashmap.h"
7 #include "advice.h"
8 #include "gettext.h"
9 #include "convert.h"
10 #include "trace.h"
11 #include "string-list.h"
12 #include "pack-revindex.h"
13
14 #include SHA1_HEADER
15 #ifndef platform_SHA_CTX
16 /*
17 * platform's underlying implementation of SHA-1; could be OpenSSL,
18 * blk_SHA, Apple CommonCrypto, etc... Note that including
19 * SHA1_HEADER may have already defined platform_SHA_CTX for our
20 * own implementations like block-sha1 and ppc-sha1, so we list
21 * the default for OpenSSL compatible SHA-1 implementations here.
22 */
23 #define platform_SHA_CTX SHA_CTX
24 #define platform_SHA1_Init SHA1_Init
25 #define platform_SHA1_Update SHA1_Update
26 #define platform_SHA1_Final SHA1_Final
27 #endif
28
29 #define git_SHA_CTX platform_SHA_CTX
30 #define git_SHA1_Init platform_SHA1_Init
31 #define git_SHA1_Update platform_SHA1_Update
32 #define git_SHA1_Final platform_SHA1_Final
33
34 #ifdef SHA1_MAX_BLOCK_SIZE
35 #include "compat/sha1-chunked.h"
36 #undef git_SHA1_Update
37 #define git_SHA1_Update git_SHA1_Update_Chunked
38 #endif
39
40 #include <zlib.h>
41 typedef struct git_zstream {
42 z_stream z;
43 unsigned long avail_in;
44 unsigned long avail_out;
45 unsigned long total_in;
46 unsigned long total_out;
47 unsigned char *next_in;
48 unsigned char *next_out;
49 } git_zstream;
50
51 void git_inflate_init(git_zstream *);
52 void git_inflate_init_gzip_only(git_zstream *);
53 void git_inflate_end(git_zstream *);
54 int git_inflate(git_zstream *, int flush);
55
56 void git_deflate_init(git_zstream *, int level);
57 void git_deflate_init_gzip(git_zstream *, int level);
58 void git_deflate_init_raw(git_zstream *, int level);
59 void git_deflate_end(git_zstream *);
60 int git_deflate_abort(git_zstream *);
61 int git_deflate_end_gently(git_zstream *);
62 int git_deflate(git_zstream *, int flush);
63 unsigned long git_deflate_bound(git_zstream *, unsigned long);
64
65 /* The length in bytes and in hex digits of an object name (SHA-1 value). */
66 #define GIT_SHA1_RAWSZ 20
67 #define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
68
69 struct object_id {
70 unsigned char hash[GIT_SHA1_RAWSZ];
71 };
72
73 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
74 #define DTYPE(de) ((de)->d_type)
75 #else
76 #undef DT_UNKNOWN
77 #undef DT_DIR
78 #undef DT_REG
79 #undef DT_LNK
80 #define DT_UNKNOWN 0
81 #define DT_DIR 1
82 #define DT_REG 2
83 #define DT_LNK 3
84 #define DTYPE(de) DT_UNKNOWN
85 #endif
86
87 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
88 #define S_IFINVALID 0030000
89
90 /*
91 * A "directory link" is a link to another git directory.
92 *
93 * The value 0160000 is not normally a valid mode, and
94 * also just happens to be S_IFDIR + S_IFLNK
95 */
96 #define S_IFGITLINK 0160000
97 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
98
99 /*
100 * Some mode bits are also used internally for computations.
101 *
102 * They *must* not overlap with any valid modes, and they *must* not be emitted
103 * to outside world - i.e. appear on disk or network. In other words, it's just
104 * temporary fields, which we internally use, but they have to stay in-house.
105 *
106 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
107 * codebase mode is `unsigned int` which is assumed to be at least 32 bits )
108 */
109
110 /* used internally in tree-diff */
111 #define S_DIFFTREE_IFXMIN_NEQ 0x80000000
112
113
114 /*
115 * Intensive research over the course of many years has shown that
116 * port 9418 is totally unused by anything else. Or
117 *
118 * Your search - "port 9418" - did not match any documents.
119 *
120 * as www.google.com puts it.
121 *
122 * This port has been properly assigned for git use by IANA:
123 * git (Assigned-9418) [I06-050728-0001].
124 *
125 * git 9418/tcp git pack transfer service
126 * git 9418/udp git pack transfer service
127 *
128 * with Linus Torvalds <torvalds@osdl.org> as the point of
129 * contact. September 2005.
130 *
131 * See http://www.iana.org/assignments/port-numbers
132 */
133 #define DEFAULT_GIT_PORT 9418
134
135 /*
136 * Basic data structures for the directory cache
137 */
138
139 #define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
140 struct cache_header {
141 uint32_t hdr_signature;
142 uint32_t hdr_version;
143 uint32_t hdr_entries;
144 };
145
146 #define INDEX_FORMAT_LB 2
147 #define INDEX_FORMAT_UB 4
148
149 /*
150 * The "cache_time" is just the low 32 bits of the
151 * time. It doesn't matter if it overflows - we only
152 * check it for equality in the 32 bits we save.
153 */
154 struct cache_time {
155 uint32_t sec;
156 uint32_t nsec;
157 };
158
159 struct stat_data {
160 struct cache_time sd_ctime;
161 struct cache_time sd_mtime;
162 unsigned int sd_dev;
163 unsigned int sd_ino;
164 unsigned int sd_uid;
165 unsigned int sd_gid;
166 unsigned int sd_size;
167 };
168
169 struct cache_entry {
170 struct hashmap_entry ent;
171 struct stat_data ce_stat_data;
172 unsigned int ce_mode;
173 unsigned int ce_flags;
174 unsigned int ce_namelen;
175 unsigned int index; /* for link extension */
176 struct object_id oid;
177 char name[FLEX_ARRAY]; /* more */
178 };
179
180 #define CE_STAGEMASK (0x3000)
181 #define CE_EXTENDED (0x4000)
182 #define CE_VALID (0x8000)
183 #define CE_STAGESHIFT 12
184
185 /*
186 * Range 0xFFFF0FFF in ce_flags is divided into
187 * two parts: in-memory flags and on-disk ones.
188 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
189 * if you want to save a new flag, add it in
190 * CE_EXTENDED_FLAGS
191 *
192 * In-memory only flags
193 */
194 #define CE_UPDATE (1 << 16)
195 #define CE_REMOVE (1 << 17)
196 #define CE_UPTODATE (1 << 18)
197 #define CE_ADDED (1 << 19)
198
199 #define CE_HASHED (1 << 20)
200 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
201 #define CE_CONFLICTED (1 << 23)
202
203 #define CE_UNPACKED (1 << 24)
204 #define CE_NEW_SKIP_WORKTREE (1 << 25)
205
206 /* used to temporarily mark paths matched by pathspecs */
207 #define CE_MATCHED (1 << 26)
208
209 #define CE_UPDATE_IN_BASE (1 << 27)
210 #define CE_STRIP_NAME (1 << 28)
211
212 /*
213 * Extended on-disk flags
214 */
215 #define CE_INTENT_TO_ADD (1 << 29)
216 #define CE_SKIP_WORKTREE (1 << 30)
217 /* CE_EXTENDED2 is for future extension */
218 #define CE_EXTENDED2 (1U << 31)
219
220 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
221
222 /*
223 * Safeguard to avoid saving wrong flags:
224 * - CE_EXTENDED2 won't get saved until its semantic is known
225 * - Bits in 0x0000FFFF have been saved in ce_flags already
226 * - Bits in 0x003F0000 are currently in-memory flags
227 */
228 #if CE_EXTENDED_FLAGS & 0x803FFFFF
229 #error "CE_EXTENDED_FLAGS out of range"
230 #endif
231
232 /* Forward structure decls */
233 struct pathspec;
234 struct child_process;
235
236 /*
237 * Copy the sha1 and stat state of a cache entry from one to
238 * another. But we never change the name, or the hash state!
239 */
240 static inline void copy_cache_entry(struct cache_entry *dst,
241 const struct cache_entry *src)
242 {
243 unsigned int state = dst->ce_flags & CE_HASHED;
244
245 /* Don't copy hash chain and name */
246 memcpy(&dst->ce_stat_data, &src->ce_stat_data,
247 offsetof(struct cache_entry, name) -
248 offsetof(struct cache_entry, ce_stat_data));
249
250 /* Restore the hash state */
251 dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
252 }
253
254 static inline unsigned create_ce_flags(unsigned stage)
255 {
256 return (stage << CE_STAGESHIFT);
257 }
258
259 #define ce_namelen(ce) ((ce)->ce_namelen)
260 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
261 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
262 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
263 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
264 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
265 #define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
266
267 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
268 static inline unsigned int create_ce_mode(unsigned int mode)
269 {
270 if (S_ISLNK(mode))
271 return S_IFLNK;
272 if (S_ISDIR(mode) || S_ISGITLINK(mode))
273 return S_IFGITLINK;
274 return S_IFREG | ce_permissions(mode);
275 }
276 static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
277 unsigned int mode)
278 {
279 extern int trust_executable_bit, has_symlinks;
280 if (!has_symlinks && S_ISREG(mode) &&
281 ce && S_ISLNK(ce->ce_mode))
282 return ce->ce_mode;
283 if (!trust_executable_bit && S_ISREG(mode)) {
284 if (ce && S_ISREG(ce->ce_mode))
285 return ce->ce_mode;
286 return create_ce_mode(0666);
287 }
288 return create_ce_mode(mode);
289 }
290 static inline int ce_to_dtype(const struct cache_entry *ce)
291 {
292 unsigned ce_mode = ntohl(ce->ce_mode);
293 if (S_ISREG(ce_mode))
294 return DT_REG;
295 else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
296 return DT_DIR;
297 else if (S_ISLNK(ce_mode))
298 return DT_LNK;
299 else
300 return DT_UNKNOWN;
301 }
302 static inline unsigned int canon_mode(unsigned int mode)
303 {
304 if (S_ISREG(mode))
305 return S_IFREG | ce_permissions(mode);
306 if (S_ISLNK(mode))
307 return S_IFLNK;
308 if (S_ISDIR(mode))
309 return S_IFDIR;
310 return S_IFGITLINK;
311 }
312
313 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
314
315 #define SOMETHING_CHANGED (1 << 0) /* unclassified changes go here */
316 #define CE_ENTRY_CHANGED (1 << 1)
317 #define CE_ENTRY_REMOVED (1 << 2)
318 #define CE_ENTRY_ADDED (1 << 3)
319 #define RESOLVE_UNDO_CHANGED (1 << 4)
320 #define CACHE_TREE_CHANGED (1 << 5)
321 #define SPLIT_INDEX_ORDERED (1 << 6)
322 #define UNTRACKED_CHANGED (1 << 7)
323
324 struct split_index;
325 struct untracked_cache;
326
327 struct index_state {
328 struct cache_entry **cache;
329 unsigned int version;
330 unsigned int cache_nr, cache_alloc, cache_changed;
331 struct string_list *resolve_undo;
332 struct cache_tree *cache_tree;
333 struct split_index *split_index;
334 struct cache_time timestamp;
335 unsigned name_hash_initialized : 1,
336 initialized : 1;
337 struct hashmap name_hash;
338 struct hashmap dir_hash;
339 unsigned char sha1[20];
340 struct untracked_cache *untracked;
341 };
342
343 extern struct index_state the_index;
344
345 /* Name hashing */
346 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
347 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
348 extern void free_name_hash(struct index_state *istate);
349
350
351 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
352 #define active_cache (the_index.cache)
353 #define active_nr (the_index.cache_nr)
354 #define active_alloc (the_index.cache_alloc)
355 #define active_cache_changed (the_index.cache_changed)
356 #define active_cache_tree (the_index.cache_tree)
357
358 #define read_cache() read_index(&the_index)
359 #define read_cache_from(path) read_index_from(&the_index, (path))
360 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
361 #define is_cache_unborn() is_index_unborn(&the_index)
362 #define read_cache_unmerged() read_index_unmerged(&the_index)
363 #define discard_cache() discard_index(&the_index)
364 #define unmerged_cache() unmerged_index(&the_index)
365 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
366 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
367 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
368 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
369 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
370 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
371 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
372 #define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
373 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
374 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
375 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
376 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
377 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
378 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
379 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
380 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
381 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
382 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
383 #endif
384
385 enum object_type {
386 OBJ_BAD = -1,
387 OBJ_NONE = 0,
388 OBJ_COMMIT = 1,
389 OBJ_TREE = 2,
390 OBJ_BLOB = 3,
391 OBJ_TAG = 4,
392 /* 5 for future expansion */
393 OBJ_OFS_DELTA = 6,
394 OBJ_REF_DELTA = 7,
395 OBJ_ANY,
396 OBJ_MAX
397 };
398
399 static inline enum object_type object_type(unsigned int mode)
400 {
401 return S_ISDIR(mode) ? OBJ_TREE :
402 S_ISGITLINK(mode) ? OBJ_COMMIT :
403 OBJ_BLOB;
404 }
405
406 /* Double-check local_repo_env below if you add to this list. */
407 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
408 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
409 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
410 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
411 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
412 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
413 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
414 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
415 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
416 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
417 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
418 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
419 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
420 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
421 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
422 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
423 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
424 #define GITATTRIBUTES_FILE ".gitattributes"
425 #define INFOATTRIBUTES_FILE "info/attributes"
426 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
427 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
428 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
429 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
430 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
431 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
432 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
433 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
434 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
435 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
436
437 /*
438 * This environment variable is expected to contain a boolean indicating
439 * whether we should or should not treat:
440 *
441 * GIT_DIR=foo.git git ...
442 *
443 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
444 * of this, but we use it internally to communicate to sub-processes that we
445 * are in a bare repo. If not set, defaults to true.
446 */
447 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
448
449 /*
450 * Repository-local GIT_* environment variables; these will be cleared
451 * when git spawns a sub-process that runs inside another repository.
452 * The array is NULL-terminated, which makes it easy to pass in the "env"
453 * parameter of a run-command invocation, or to do a simple walk.
454 */
455 extern const char * const local_repo_env[];
456
457 /*
458 * Returns true iff we have a configured git repository (either via
459 * setup_git_directory, or in the environment via $GIT_DIR).
460 */
461 int have_git_dir(void);
462
463 extern int is_bare_repository_cfg;
464 extern int is_bare_repository(void);
465 extern int is_inside_git_dir(void);
466 extern char *git_work_tree_cfg;
467 extern int is_inside_work_tree(void);
468 extern const char *get_git_dir(void);
469 extern const char *get_git_common_dir(void);
470 extern char *get_object_directory(void);
471 extern char *get_index_file(void);
472 extern char *get_graft_file(void);
473 extern int set_git_dir(const char *path);
474 extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
475 extern int get_common_dir(struct strbuf *sb, const char *gitdir);
476 extern const char *get_git_namespace(void);
477 extern const char *strip_namespace(const char *namespaced_ref);
478 extern const char *get_git_work_tree(void);
479
480 /*
481 * Return true if the given path is a git directory; note that this _just_
482 * looks at the directory itself. If you want to know whether "foo/.git"
483 * is a repository, you must feed that path, not just "foo".
484 */
485 extern int is_git_directory(const char *path);
486
487 /*
488 * Return 1 if the given path is the root of a git repository or
489 * submodule, else 0. Will not return 1 for bare repositories with the
490 * exception of creating a bare repository in "foo/.git" and calling
491 * is_git_repository("foo").
492 *
493 * If we run into read errors, we err on the side of saying "yes, it is",
494 * as we usually consider sub-repos precious, and would prefer to err on the
495 * side of not disrupting or deleting them.
496 */
497 extern int is_nonbare_repository_dir(struct strbuf *path);
498
499 #define READ_GITFILE_ERR_STAT_FAILED 1
500 #define READ_GITFILE_ERR_NOT_A_FILE 2
501 #define READ_GITFILE_ERR_OPEN_FAILED 3
502 #define READ_GITFILE_ERR_READ_FAILED 4
503 #define READ_GITFILE_ERR_INVALID_FORMAT 5
504 #define READ_GITFILE_ERR_NO_PATH 6
505 #define READ_GITFILE_ERR_NOT_A_REPO 7
506 #define READ_GITFILE_ERR_TOO_LARGE 8
507 extern const char *read_gitfile_gently(const char *path, int *return_error_code);
508 #define read_gitfile(path) read_gitfile_gently((path), NULL)
509 extern const char *resolve_gitdir(const char *suspect);
510 extern void set_git_work_tree(const char *tree);
511
512 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
513
514 extern const char **get_pathspec(const char *prefix, const char **pathspec);
515 extern void setup_work_tree(void);
516 extern const char *setup_git_directory_gently(int *);
517 extern const char *setup_git_directory(void);
518 extern char *prefix_path(const char *prefix, int len, const char *path);
519 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
520 extern const char *prefix_filename(const char *prefix, int len, const char *path);
521 extern int check_filename(const char *prefix, const char *name);
522 extern void verify_filename(const char *prefix,
523 const char *name,
524 int diagnose_misspelt_rev);
525 extern void verify_non_filename(const char *prefix, const char *name);
526 extern int path_inside_repo(const char *prefix, const char *path);
527
528 #define INIT_DB_QUIET 0x0001
529 #define INIT_DB_EXIST_OK 0x0002
530
531 extern int init_db(const char *git_dir, const char *real_git_dir,
532 const char *template_dir, unsigned int flags);
533
534 extern void sanitize_stdfds(void);
535 extern int daemonize(void);
536
537 #define alloc_nr(x) (((x)+16)*3/2)
538
539 /*
540 * Realloc the buffer pointed at by variable 'x' so that it can hold
541 * at least 'nr' entries; the number of entries currently allocated
542 * is 'alloc', using the standard growing factor alloc_nr() macro.
543 *
544 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
545 */
546 #define ALLOC_GROW(x, nr, alloc) \
547 do { \
548 if ((nr) > alloc) { \
549 if (alloc_nr(alloc) < (nr)) \
550 alloc = (nr); \
551 else \
552 alloc = alloc_nr(alloc); \
553 REALLOC_ARRAY(x, alloc); \
554 } \
555 } while (0)
556
557 /* Initialize and use the cache information */
558 struct lock_file;
559 extern int read_index(struct index_state *);
560 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
561 extern int do_read_index(struct index_state *istate, const char *path,
562 int must_exist); /* for testting only! */
563 extern int read_index_from(struct index_state *, const char *path);
564 extern int is_index_unborn(struct index_state *);
565 extern int read_index_unmerged(struct index_state *);
566 #define COMMIT_LOCK (1 << 0)
567 #define CLOSE_LOCK (1 << 1)
568 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
569 extern int discard_index(struct index_state *);
570 extern int unmerged_index(const struct index_state *);
571 extern int verify_path(const char *path);
572 extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
573 extern void adjust_dirname_case(struct index_state *istate, char *name);
574 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
575 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
576 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
577 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
578 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
579 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
580 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
581 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
582 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
583 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
584 extern int remove_index_entry_at(struct index_state *, int pos);
585 extern void remove_marked_cache_entries(struct index_state *istate);
586 extern int remove_file_from_index(struct index_state *, const char *path);
587 #define ADD_CACHE_VERBOSE 1
588 #define ADD_CACHE_PRETEND 2
589 #define ADD_CACHE_IGNORE_ERRORS 4
590 #define ADD_CACHE_IGNORE_REMOVAL 8
591 #define ADD_CACHE_INTENT 16
592 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
593 extern int add_file_to_index(struct index_state *, const char *path, int flags);
594 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
595 extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
596 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
597 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
598 extern int index_name_is_other(const struct index_state *, const char *, int);
599 extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
600
601 /* do stat comparison even if CE_VALID is true */
602 #define CE_MATCH_IGNORE_VALID 01
603 /* do not check the contents but report dirty on racily-clean entries */
604 #define CE_MATCH_RACY_IS_DIRTY 02
605 /* do stat comparison even if CE_SKIP_WORKTREE is true */
606 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
607 /* ignore non-existent files during stat update */
608 #define CE_MATCH_IGNORE_MISSING 0x08
609 /* enable stat refresh */
610 #define CE_MATCH_REFRESH 0x10
611 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
612 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
613
614 #define HASH_WRITE_OBJECT 1
615 #define HASH_FORMAT_CHECK 2
616 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
617 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
618
619 /*
620 * Record to sd the data from st that we use to check whether a file
621 * might have changed.
622 */
623 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
624
625 /*
626 * Return 0 if st is consistent with a file not having been changed
627 * since sd was filled. If there are differences, return a
628 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
629 * INODE_CHANGED, and DATA_CHANGED.
630 */
631 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
632 extern int match_stat_data_racy(const struct index_state *istate,
633 const struct stat_data *sd, struct stat *st);
634
635 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
636
637 #define REFRESH_REALLY 0x0001 /* ignore_valid */
638 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
639 #define REFRESH_QUIET 0x0004 /* be quiet about it */
640 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
641 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
642 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
643 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
644 extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int);
645
646 extern void update_index_if_able(struct index_state *, struct lock_file *);
647
648 extern int hold_locked_index(struct lock_file *, int);
649 extern void set_alternate_index_output(const char *);
650
651 /* Environment bits from configuration mechanism */
652 extern int trust_executable_bit;
653 extern int trust_ctime;
654 extern int check_stat;
655 extern int quote_path_fully;
656 extern int has_symlinks;
657 extern int minimum_abbrev, default_abbrev;
658 extern int ignore_case;
659 extern int assume_unchanged;
660 extern int prefer_symlink_refs;
661 extern int log_all_ref_updates;
662 extern int warn_ambiguous_refs;
663 extern int warn_on_object_refname_ambiguity;
664 extern const char *apply_default_whitespace;
665 extern const char *apply_default_ignorewhitespace;
666 extern const char *git_attributes_file;
667 extern const char *git_hooks_path;
668 extern int zlib_compression_level;
669 extern int core_compression_level;
670 extern int core_compression_seen;
671 extern size_t packed_git_window_size;
672 extern size_t packed_git_limit;
673 extern size_t delta_base_cache_limit;
674 extern unsigned long big_file_threshold;
675 extern unsigned long pack_size_limit_cfg;
676
677 /*
678 * Accessors for the core.sharedrepository config which lazy-load the value
679 * from the config (if not already set). The "reset" function can be
680 * used to unset "set" or cached value, meaning that the value will be loaded
681 * fresh from the config file on the next call to get_shared_repository().
682 */
683 void set_shared_repository(int value);
684 int get_shared_repository(void);
685 void reset_shared_repository(void);
686
687 /*
688 * Do replace refs need to be checked this run? This variable is
689 * initialized to true unless --no-replace-object is used or
690 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
691 * commands that do not want replace references to be active. As an
692 * optimization it is also set to false if replace references have
693 * been sought but there were none.
694 */
695 extern int check_replace_refs;
696 extern char *git_replace_ref_base;
697
698 extern int fsync_object_files;
699 extern int core_preload_index;
700 extern int core_apply_sparse_checkout;
701 extern int precomposed_unicode;
702 extern int protect_hfs;
703 extern int protect_ntfs;
704 extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
705
706 /*
707 * Include broken refs in all ref iterations, which will
708 * generally choke dangerous operations rather than letting
709 * them silently proceed without taking the broken ref into
710 * account.
711 */
712 extern int ref_paranoia;
713
714 /*
715 * The character that begins a commented line in user-editable file
716 * that is subject to stripspace.
717 */
718 extern char comment_line_char;
719 extern int auto_comment_line_char;
720
721 /* Windows only */
722 enum hide_dotfiles_type {
723 HIDE_DOTFILES_FALSE = 0,
724 HIDE_DOTFILES_TRUE,
725 HIDE_DOTFILES_DOTGITONLY
726 };
727 extern enum hide_dotfiles_type hide_dotfiles;
728
729 enum branch_track {
730 BRANCH_TRACK_UNSPECIFIED = -1,
731 BRANCH_TRACK_NEVER = 0,
732 BRANCH_TRACK_REMOTE,
733 BRANCH_TRACK_ALWAYS,
734 BRANCH_TRACK_EXPLICIT,
735 BRANCH_TRACK_OVERRIDE
736 };
737
738 enum rebase_setup_type {
739 AUTOREBASE_NEVER = 0,
740 AUTOREBASE_LOCAL,
741 AUTOREBASE_REMOTE,
742 AUTOREBASE_ALWAYS
743 };
744
745 enum push_default_type {
746 PUSH_DEFAULT_NOTHING = 0,
747 PUSH_DEFAULT_MATCHING,
748 PUSH_DEFAULT_SIMPLE,
749 PUSH_DEFAULT_UPSTREAM,
750 PUSH_DEFAULT_CURRENT,
751 PUSH_DEFAULT_UNSPECIFIED
752 };
753
754 extern enum branch_track git_branch_track;
755 extern enum rebase_setup_type autorebase;
756 extern enum push_default_type push_default;
757
758 enum object_creation_mode {
759 OBJECT_CREATION_USES_HARDLINKS = 0,
760 OBJECT_CREATION_USES_RENAMES = 1
761 };
762
763 extern enum object_creation_mode object_creation_mode;
764
765 extern char *notes_ref_name;
766
767 extern int grafts_replace_parents;
768
769 /*
770 * GIT_REPO_VERSION is the version we write by default. The
771 * _READ variant is the highest number we know how to
772 * handle.
773 */
774 #define GIT_REPO_VERSION 0
775 #define GIT_REPO_VERSION_READ 1
776 extern int repository_format_precious_objects;
777
778 struct repository_format {
779 int version;
780 int precious_objects;
781 int is_bare;
782 char *work_tree;
783 struct string_list unknown_extensions;
784 };
785
786 /*
787 * Read the repository format characteristics from the config file "path" into
788 * "format" struct. Returns the numeric version. On error, -1 is returned,
789 * format->version is set to -1, and all other fields in the struct are
790 * undefined.
791 */
792 int read_repository_format(struct repository_format *format, const char *path);
793
794 /*
795 * Verify that the repository described by repository_format is something we
796 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
797 * any errors encountered.
798 */
799 int verify_repository_format(const struct repository_format *format,
800 struct strbuf *err);
801
802 /*
803 * Check the repository format version in the path found in get_git_dir(),
804 * and die if it is a version we don't understand. Generally one would
805 * set_git_dir() before calling this, and use it only for "are we in a valid
806 * repo?".
807 */
808 extern void check_repository_format(void);
809
810 #define MTIME_CHANGED 0x0001
811 #define CTIME_CHANGED 0x0002
812 #define OWNER_CHANGED 0x0004
813 #define MODE_CHANGED 0x0008
814 #define INODE_CHANGED 0x0010
815 #define DATA_CHANGED 0x0020
816 #define TYPE_CHANGED 0x0040
817
818 /*
819 * Return a statically allocated filename, either generically (mkpath), in
820 * the repository directory (git_path), or in a submodule's repository
821 * directory (git_path_submodule). In all cases, note that the result
822 * may be overwritten by another call to _any_ of the functions. Consider
823 * using the safer "dup" or "strbuf" formats below (in some cases, the
824 * unsafe versions have already been removed).
825 */
826 extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
827 extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
828 extern const char *git_common_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
829
830 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
831 __attribute__((format (printf, 3, 4)));
832 extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
833 __attribute__((format (printf, 2, 3)));
834 extern void strbuf_git_common_path(struct strbuf *sb, const char *fmt, ...)
835 __attribute__((format (printf, 2, 3)));
836 extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
837 __attribute__((format (printf, 2, 3)));
838 extern int strbuf_git_path_submodule(struct strbuf *sb, const char *path,
839 const char *fmt, ...)
840 __attribute__((format (printf, 3, 4)));
841 extern char *git_pathdup(const char *fmt, ...)
842 __attribute__((format (printf, 1, 2)));
843 extern char *mkpathdup(const char *fmt, ...)
844 __attribute__((format (printf, 1, 2)));
845 extern char *git_pathdup_submodule(const char *path, const char *fmt, ...)
846 __attribute__((format (printf, 2, 3)));
847
848 extern void report_linked_checkout_garbage(void);
849
850 /*
851 * You can define a static memoized git path like:
852 *
853 * static GIT_PATH_FUNC(git_path_foo, "FOO");
854 *
855 * or use one of the global ones below.
856 */
857 #define GIT_PATH_FUNC(func, filename) \
858 const char *func(void) \
859 { \
860 static char *ret; \
861 if (!ret) \
862 ret = git_pathdup(filename); \
863 return ret; \
864 }
865
866 const char *git_path_cherry_pick_head(void);
867 const char *git_path_revert_head(void);
868 const char *git_path_squash_msg(void);
869 const char *git_path_merge_msg(void);
870 const char *git_path_merge_rr(void);
871 const char *git_path_merge_mode(void);
872 const char *git_path_merge_head(void);
873 const char *git_path_fetch_head(void);
874 const char *git_path_shallow(void);
875
876 /*
877 * Return the name of the file in the local object database that would
878 * be used to store a loose object with the specified sha1. The
879 * return value is a pointer to a statically allocated buffer that is
880 * overwritten each time the function is called.
881 */
882 extern const char *sha1_file_name(const unsigned char *sha1);
883
884 /*
885 * Return the name of the (local) packfile with the specified sha1 in
886 * its name. The return value is a pointer to memory that is
887 * overwritten each time this function is called.
888 */
889 extern char *sha1_pack_name(const unsigned char *sha1);
890
891 /*
892 * Return the name of the (local) pack index file with the specified
893 * sha1 in its name. The return value is a pointer to memory that is
894 * overwritten each time this function is called.
895 */
896 extern char *sha1_pack_index_name(const unsigned char *sha1);
897
898 /*
899 * Return an abbreviated sha1 unique within this repository's object database.
900 * The result will be at least `len` characters long, and will be NUL
901 * terminated.
902 *
903 * The non-`_r` version returns a static buffer which will be overwritten by
904 * subsequent calls.
905 *
906 * The `_r` variant writes to a buffer supplied by the caller, which must be at
907 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
908 * written (excluding the NUL terminator).
909 *
910 * Note that while this version avoids the static buffer, it is not fully
911 * reentrant, as it calls into other non-reentrant git code.
912 */
913 extern const char *find_unique_abbrev(const unsigned char *sha1, int len);
914 extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len);
915
916 extern const unsigned char null_sha1[GIT_SHA1_RAWSZ];
917 extern const struct object_id null_oid;
918
919 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
920 {
921 int i;
922
923 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
924 if (*sha1 != *sha2)
925 return *sha1 - *sha2;
926 }
927
928 return 0;
929 }
930
931 static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
932 {
933 return hashcmp(oid1->hash, oid2->hash);
934 }
935
936 static inline int is_null_sha1(const unsigned char *sha1)
937 {
938 return !hashcmp(sha1, null_sha1);
939 }
940
941 static inline int is_null_oid(const struct object_id *oid)
942 {
943 return !hashcmp(oid->hash, null_sha1);
944 }
945
946 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
947 {
948 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
949 }
950
951 static inline void oidcpy(struct object_id *dst, const struct object_id *src)
952 {
953 hashcpy(dst->hash, src->hash);
954 }
955
956 static inline void hashclr(unsigned char *hash)
957 {
958 memset(hash, 0, GIT_SHA1_RAWSZ);
959 }
960
961 static inline void oidclr(struct object_id *oid)
962 {
963 hashclr(oid->hash);
964 }
965
966
967 #define EMPTY_TREE_SHA1_HEX \
968 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
969 #define EMPTY_TREE_SHA1_BIN_LITERAL \
970 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
971 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
972 extern const struct object_id empty_tree_oid;
973 #define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)
974
975 #define EMPTY_BLOB_SHA1_HEX \
976 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
977 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
978 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
979 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
980 extern const struct object_id empty_blob_oid;
981 #define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)
982
983
984 static inline int is_empty_blob_sha1(const unsigned char *sha1)
985 {
986 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
987 }
988
989 static inline int is_empty_blob_oid(const struct object_id *oid)
990 {
991 return !hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);
992 }
993
994 static inline int is_empty_tree_sha1(const unsigned char *sha1)
995 {
996 return !hashcmp(sha1, EMPTY_TREE_SHA1_BIN);
997 }
998
999 static inline int is_empty_tree_oid(const struct object_id *oid)
1000 {
1001 return !hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);
1002 }
1003
1004
1005 int git_mkstemp(char *path, size_t n, const char *template);
1006
1007 /* set default permissions by passing mode arguments to open(2) */
1008 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
1009 int git_mkstemp_mode(char *pattern, int mode);
1010
1011 /*
1012 * NOTE NOTE NOTE!!
1013 *
1014 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1015 * not be changed. Old repositories have core.sharedrepository written in
1016 * numeric format, and therefore these values are preserved for compatibility
1017 * reasons.
1018 */
1019 enum sharedrepo {
1020 PERM_UMASK = 0,
1021 OLD_PERM_GROUP = 1,
1022 OLD_PERM_EVERYBODY = 2,
1023 PERM_GROUP = 0660,
1024 PERM_EVERYBODY = 0664
1025 };
1026 int git_config_perm(const char *var, const char *value);
1027 int adjust_shared_perm(const char *path);
1028
1029 /*
1030 * Create the directory containing the named path, using care to be
1031 * somewhat safe against races. Return one of the scld_error values
1032 * to indicate success/failure.
1033 *
1034 * SCLD_VANISHED indicates that one of the ancestor directories of the
1035 * path existed at one point during the function call and then
1036 * suddenly vanished, probably because another process pruned the
1037 * directory while we were working. To be robust against this kind of
1038 * race, callers might want to try invoking the function again when it
1039 * returns SCLD_VANISHED.
1040 *
1041 * safe_create_leading_directories() temporarily changes path while it
1042 * is working but restores it before returning.
1043 * safe_create_leading_directories_const() doesn't modify path, even
1044 * temporarily.
1045 */
1046 enum scld_error {
1047 SCLD_OK = 0,
1048 SCLD_FAILED = -1,
1049 SCLD_PERMS = -2,
1050 SCLD_EXISTS = -3,
1051 SCLD_VANISHED = -4
1052 };
1053 enum scld_error safe_create_leading_directories(char *path);
1054 enum scld_error safe_create_leading_directories_const(const char *path);
1055
1056 int mkdir_in_gitdir(const char *path);
1057 extern char *expand_user_path(const char *path);
1058 const char *enter_repo(const char *path, int strict);
1059 static inline int is_absolute_path(const char *path)
1060 {
1061 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
1062 }
1063 int is_directory(const char *);
1064 const char *real_path(const char *path);
1065 const char *real_path_if_valid(const char *path);
1066 const char *absolute_path(const char *path);
1067 const char *remove_leading_path(const char *in, const char *prefix);
1068 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
1069 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
1070 int normalize_path_copy(char *dst, const char *src);
1071 int longest_ancestor_length(const char *path, struct string_list *prefixes);
1072 char *strip_path_suffix(const char *path, const char *suffix);
1073 int daemon_avoid_alias(const char *path);
1074 extern int is_ntfs_dotgit(const char *name);
1075
1076 /**
1077 * Return a newly allocated string with the evaluation of
1078 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1079 * "$HOME/.config/git/$filename". Return NULL upon error.
1080 */
1081 extern char *xdg_config_home(const char *filename);
1082
1083 /* object replacement */
1084 #define LOOKUP_REPLACE_OBJECT 1
1085 #define LOOKUP_UNKNOWN_OBJECT 2
1086 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
1087 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
1088 {
1089 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
1090 }
1091
1092 /*
1093 * This internal function is only declared here for the benefit of
1094 * lookup_replace_object(). Please do not call it directly.
1095 */
1096 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
1097
1098 /*
1099 * If object sha1 should be replaced, return the replacement object's
1100 * name (replaced recursively, if necessary). The return value is
1101 * either sha1 or a pointer to a permanently-allocated value. When
1102 * object replacement is suppressed, always return sha1.
1103 */
1104 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1105 {
1106 if (!check_replace_refs)
1107 return sha1;
1108 return do_lookup_replace_object(sha1);
1109 }
1110
1111 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
1112 {
1113 if (!(flag & LOOKUP_REPLACE_OBJECT))
1114 return sha1;
1115 return lookup_replace_object(sha1);
1116 }
1117
1118 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
1119 extern int sha1_object_info(const unsigned char *, unsigned long *);
1120 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
1121 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
1122 extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);
1123 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
1124 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
1125 extern int git_open_noatime(const char *name);
1126 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
1127 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
1128 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
1129
1130 /* global flag to enable extra checks when accessing packed objects */
1131 extern int do_check_packed_object_crc;
1132
1133 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
1134
1135 extern int finalize_object_file(const char *tmpfile, const char *filename);
1136
1137 extern int has_sha1_pack(const unsigned char *sha1);
1138
1139 /*
1140 * Return true iff we have an object named sha1, whether local or in
1141 * an alternate object database, and whether packed or loose. This
1142 * function does not respect replace references.
1143 *
1144 * If the QUICK flag is set, do not re-check the pack directory
1145 * when we cannot find the object (this means we may give a false
1146 * negative answer if another process is simultaneously repacking).
1147 */
1148 #define HAS_SHA1_QUICK 0x1
1149 extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1150 static inline int has_sha1_file(const unsigned char *sha1)
1151 {
1152 return has_sha1_file_with_flags(sha1, 0);
1153 }
1154
1155 /* Same as the above, except for struct object_id. */
1156 extern int has_object_file(const struct object_id *oid);
1157
1158 /*
1159 * Return true iff an alternate object database has a loose object
1160 * with the specified name. This function does not respect replace
1161 * references.
1162 */
1163 extern int has_loose_object_nonlocal(const unsigned char *sha1);
1164
1165 extern int has_pack_index(const unsigned char *sha1);
1166
1167 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1168
1169 extern const signed char hexval_table[256];
1170 static inline unsigned int hexval(unsigned char c)
1171 {
1172 return hexval_table[c];
1173 }
1174
1175 /*
1176 * Convert two consecutive hexadecimal digits into a char. Return a
1177 * negative value on error. Don't run over the end of short strings.
1178 */
1179 static inline int hex2chr(const char *s)
1180 {
1181 int val = hexval(s[0]);
1182 return (val < 0) ? val : (val << 4) | hexval(s[1]);
1183 }
1184
1185 /* Convert to/from hex/sha1 representation */
1186 #define MINIMUM_ABBREV minimum_abbrev
1187 #define DEFAULT_ABBREV default_abbrev
1188
1189 struct object_context {
1190 unsigned char tree[20];
1191 char path[PATH_MAX];
1192 unsigned mode;
1193 /*
1194 * symlink_path is only used by get_tree_entry_follow_symlinks,
1195 * and only for symlinks that point outside the repository.
1196 */
1197 struct strbuf symlink_path;
1198 };
1199
1200 #define GET_SHA1_QUIETLY 01
1201 #define GET_SHA1_COMMIT 02
1202 #define GET_SHA1_COMMITTISH 04
1203 #define GET_SHA1_TREE 010
1204 #define GET_SHA1_TREEISH 020
1205 #define GET_SHA1_BLOB 040
1206 #define GET_SHA1_FOLLOW_SYMLINKS 0100
1207 #define GET_SHA1_ONLY_TO_DIE 04000
1208
1209 extern int get_sha1(const char *str, unsigned char *sha1);
1210 extern int get_sha1_commit(const char *str, unsigned char *sha1);
1211 extern int get_sha1_committish(const char *str, unsigned char *sha1);
1212 extern int get_sha1_tree(const char *str, unsigned char *sha1);
1213 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
1214 extern int get_sha1_blob(const char *str, unsigned char *sha1);
1215 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1216 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
1217
1218 extern int get_oid(const char *str, struct object_id *oid);
1219
1220 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
1221 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1222
1223 /*
1224 * Try to read a SHA1 in hexadecimal format from the 40 characters
1225 * starting at hex. Write the 20-byte result to sha1 in binary form.
1226 * Return 0 on success. Reading stops if a NUL is encountered in the
1227 * input, so it is safe to pass this function an arbitrary
1228 * null-terminated string.
1229 */
1230 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1231 extern int get_oid_hex(const char *hex, struct object_id *sha1);
1232
1233 /*
1234 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1235 * and writes the NUL-terminated output to the buffer `out`, which must be at
1236 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1237 * convenience.
1238 *
1239 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1240 * buffers, making it safe to make multiple calls for a single statement, like:
1241 *
1242 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1243 */
1244 extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
1245 extern char *oid_to_hex_r(char *out, const struct object_id *oid);
1246 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
1247 extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
1248
1249 extern int interpret_branch_name(const char *str, int len, struct strbuf *);
1250 extern int get_oid_mb(const char *str, struct object_id *oid);
1251
1252 extern int validate_headref(const char *ref);
1253
1254 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1255 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1256 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1257 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1258
1259 extern void *read_object_with_reference(const unsigned char *sha1,
1260 const char *required_type,
1261 unsigned long *size,
1262 unsigned char *sha1_ret);
1263
1264 extern struct object *peel_to_type(const char *name, int namelen,
1265 struct object *o, enum object_type);
1266
1267 struct date_mode {
1268 enum date_mode_type {
1269 DATE_NORMAL = 0,
1270 DATE_RELATIVE,
1271 DATE_SHORT,
1272 DATE_ISO8601,
1273 DATE_ISO8601_STRICT,
1274 DATE_RFC2822,
1275 DATE_STRFTIME,
1276 DATE_RAW,
1277 DATE_UNIX
1278 } type;
1279 const char *strftime_fmt;
1280 int local;
1281 };
1282
1283 /*
1284 * Convenience helper for passing a constant type, like:
1285 *
1286 * show_date(t, tz, DATE_MODE(NORMAL));
1287 */
1288 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1289 struct date_mode *date_mode_from_type(enum date_mode_type type);
1290
1291 const char *show_date(unsigned long time, int timezone, const struct date_mode *mode);
1292 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1293 struct strbuf *timebuf);
1294 int parse_date(const char *date, struct strbuf *out);
1295 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
1296 int parse_expiry_date(const char *date, unsigned long *timestamp);
1297 void datestamp(struct strbuf *out);
1298 #define approxidate(s) approxidate_careful((s), NULL)
1299 unsigned long approxidate_careful(const char *, int *);
1300 unsigned long approxidate_relative(const char *date, const struct timeval *now);
1301 void parse_date_format(const char *format, struct date_mode *mode);
1302 int date_overflows(unsigned long date);
1303
1304 #define IDENT_STRICT 1
1305 #define IDENT_NO_DATE 2
1306 #define IDENT_NO_NAME 4
1307 extern const char *git_author_info(int);
1308 extern const char *git_committer_info(int);
1309 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1310 extern const char *fmt_name(const char *name, const char *email);
1311 extern const char *ident_default_name(void);
1312 extern const char *ident_default_email(void);
1313 extern const char *git_editor(void);
1314 extern const char *git_pager(int stdout_is_tty);
1315 extern int git_ident_config(const char *, const char *, void *);
1316 extern void reset_ident_date(void);
1317
1318 struct ident_split {
1319 const char *name_begin;
1320 const char *name_end;
1321 const char *mail_begin;
1322 const char *mail_end;
1323 const char *date_begin;
1324 const char *date_end;
1325 const char *tz_begin;
1326 const char *tz_end;
1327 };
1328 /*
1329 * Signals an success with 0, but time part of the result may be NULL
1330 * if the input lacks timestamp and zone
1331 */
1332 extern int split_ident_line(struct ident_split *, const char *, int);
1333
1334 /*
1335 * Like show_date, but pull the timestamp and tz parameters from
1336 * the ident_split. It will also sanity-check the values and produce
1337 * a well-known sentinel date if they appear bogus.
1338 */
1339 const char *show_ident_date(const struct ident_split *id,
1340 const struct date_mode *mode);
1341
1342 /*
1343 * Compare split idents for equality or strict ordering. Note that we
1344 * compare only the ident part of the line, ignoring any timestamp.
1345 *
1346 * Because there are two fields, we must choose one as the primary key; we
1347 * currently arbitrarily pick the email.
1348 */
1349 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1350
1351 struct checkout {
1352 struct index_state *istate;
1353 const char *base_dir;
1354 int base_dir_len;
1355 unsigned force:1,
1356 quiet:1,
1357 not_new:1,
1358 refresh_cache:1;
1359 };
1360 #define CHECKOUT_INIT { NULL, "" }
1361
1362 #define TEMPORARY_FILENAME_LENGTH 25
1363 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1364
1365 struct cache_def {
1366 struct strbuf path;
1367 int flags;
1368 int track_flags;
1369 int prefix_len_stat_func;
1370 };
1371 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1372 static inline void cache_def_clear(struct cache_def *cache)
1373 {
1374 strbuf_release(&cache->path);
1375 }
1376
1377 extern int has_symlink_leading_path(const char *name, int len);
1378 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1379 extern int check_leading_path(const char *name, int len);
1380 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1381 extern void schedule_dir_for_removal(const char *name, int len);
1382 extern void remove_scheduled_dirs(void);
1383
1384 extern struct alternate_object_database {
1385 struct alternate_object_database *next;
1386 char *name;
1387 char base[FLEX_ARRAY]; /* more */
1388 } *alt_odb_list;
1389 extern void prepare_alt_odb(void);
1390 extern void read_info_alternates(const char * relative_base, int depth);
1391 extern char *compute_alternate_path(const char *path, struct strbuf *err);
1392 extern void add_to_alternates_file(const char *reference);
1393 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1394 extern int foreach_alt_odb(alt_odb_fn, void*);
1395
1396 struct pack_window {
1397 struct pack_window *next;
1398 unsigned char *base;
1399 off_t offset;
1400 size_t len;
1401 unsigned int last_used;
1402 unsigned int inuse_cnt;
1403 };
1404
1405 extern struct packed_git {
1406 struct packed_git *next;
1407 struct pack_window *windows;
1408 off_t pack_size;
1409 const void *index_data;
1410 size_t index_size;
1411 uint32_t num_objects;
1412 uint32_t num_bad_objects;
1413 unsigned char *bad_object_sha1;
1414 int index_version;
1415 time_t mtime;
1416 int pack_fd;
1417 unsigned pack_local:1,
1418 pack_keep:1,
1419 freshened:1,
1420 do_not_close:1;
1421 unsigned char sha1[20];
1422 struct revindex_entry *revindex;
1423 /* something like ".git/objects/pack/xxxxx.pack" */
1424 char pack_name[FLEX_ARRAY]; /* more */
1425 } *packed_git;
1426
1427 /*
1428 * A most-recently-used ordered version of the packed_git list, which can
1429 * be iterated instead of packed_git (and marked via mru_mark).
1430 */
1431 struct mru;
1432 extern struct mru *packed_git_mru;
1433
1434 struct pack_entry {
1435 off_t offset;
1436 unsigned char sha1[20];
1437 struct packed_git *p;
1438 };
1439
1440 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1441
1442 /* A hook to report invalid files in pack directory */
1443 #define PACKDIR_FILE_PACK 1
1444 #define PACKDIR_FILE_IDX 2
1445 #define PACKDIR_FILE_GARBAGE 4
1446 extern void (*report_garbage)(unsigned seen_bits, const char *path);
1447
1448 extern void prepare_packed_git(void);
1449 extern void reprepare_packed_git(void);
1450 extern void install_packed_git(struct packed_git *pack);
1451
1452 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1453 struct packed_git *packs);
1454
1455 extern void pack_report(void);
1456
1457 /*
1458 * mmap the index file for the specified packfile (if it is not
1459 * already mmapped). Return 0 on success.
1460 */
1461 extern int open_pack_index(struct packed_git *);
1462
1463 /*
1464 * munmap the index file for the specified packfile (if it is
1465 * currently mmapped).
1466 */
1467 extern void close_pack_index(struct packed_git *);
1468
1469 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1470 extern void close_pack_windows(struct packed_git *);
1471 extern void close_all_packs(void);
1472 extern void unuse_pack(struct pack_window **);
1473 extern void clear_delta_base_cache(void);
1474 extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
1475
1476 /*
1477 * Make sure that a pointer access into an mmap'd index file is within bounds,
1478 * and can provide at least 8 bytes of data.
1479 *
1480 * Note that this is only necessary for variable-length segments of the file
1481 * (like the 64-bit extended offset table), as we compare the size to the
1482 * fixed-length parts when we open the file.
1483 */
1484 extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
1485
1486 /*
1487 * Return the SHA-1 of the nth object within the specified packfile.
1488 * Open the index if it is not already open. The return value points
1489 * at the SHA-1 within the mmapped index. Return NULL if there is an
1490 * error.
1491 */
1492 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1493
1494 /*
1495 * Return the offset of the nth object within the specified packfile.
1496 * The index must already be opened.
1497 */
1498 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1499
1500 /*
1501 * If the object named sha1 is present in the specified packfile,
1502 * return its offset within the packfile; otherwise, return 0.
1503 */
1504 extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1505
1506 extern int is_pack_valid(struct packed_git *);
1507 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1508 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1509 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1510 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1511
1512 /*
1513 * Iterate over the files in the loose-object parts of the object
1514 * directory "path", triggering the following callbacks:
1515 *
1516 * - loose_object is called for each loose object we find.
1517 *
1518 * - loose_cruft is called for any files that do not appear to be
1519 * loose objects. Note that we only look in the loose object
1520 * directories "objects/[0-9a-f]{2}/", so we will not report
1521 * "objects/foobar" as cruft.
1522 *
1523 * - loose_subdir is called for each top-level hashed subdirectory
1524 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1525 * after the objects in the directory are processed.
1526 *
1527 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1528 * will end the iteration.
1529 *
1530 * In the "buf" variant, "path" is a strbuf which will also be used as a
1531 * scratch buffer, but restored to its original contents before
1532 * the function returns.
1533 */
1534 typedef int each_loose_object_fn(const unsigned char *sha1,
1535 const char *path,
1536 void *data);
1537 typedef int each_loose_cruft_fn(const char *basename,
1538 const char *path,
1539 void *data);
1540 typedef int each_loose_subdir_fn(int nr,
1541 const char *path,
1542 void *data);
1543 int for_each_loose_file_in_objdir(const char *path,
1544 each_loose_object_fn obj_cb,
1545 each_loose_cruft_fn cruft_cb,
1546 each_loose_subdir_fn subdir_cb,
1547 void *data);
1548 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1549 each_loose_object_fn obj_cb,
1550 each_loose_cruft_fn cruft_cb,
1551 each_loose_subdir_fn subdir_cb,
1552 void *data);
1553
1554 /*
1555 * Iterate over loose and packed objects in both the local
1556 * repository and any alternates repositories (unless the
1557 * LOCAL_ONLY flag is set).
1558 */
1559 #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1560 typedef int each_packed_object_fn(const unsigned char *sha1,
1561 struct packed_git *pack,
1562 uint32_t pos,
1563 void *data);
1564 extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1565 extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
1566
1567 struct object_info {
1568 /* Request */
1569 enum object_type *typep;
1570 unsigned long *sizep;
1571 off_t *disk_sizep;
1572 unsigned char *delta_base_sha1;
1573 struct strbuf *typename;
1574
1575 /* Response */
1576 enum {
1577 OI_CACHED,
1578 OI_LOOSE,
1579 OI_PACKED,
1580 OI_DBCACHED
1581 } whence;
1582 union {
1583 /*
1584 * struct {
1585 * ... Nothing to expose in this case
1586 * } cached;
1587 * struct {
1588 * ... Nothing to expose in this case
1589 * } loose;
1590 */
1591 struct {
1592 struct packed_git *pack;
1593 off_t offset;
1594 unsigned int is_delta;
1595 } packed;
1596 } u;
1597 };
1598 extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1599
1600 /* Dumb servers support */
1601 extern int update_server_info(int);
1602
1603 /* git_config_parse_key() returns these negated: */
1604 #define CONFIG_INVALID_KEY 1
1605 #define CONFIG_NO_SECTION_OR_NAME 2
1606 /* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */
1607 #define CONFIG_NO_LOCK -1
1608 #define CONFIG_INVALID_FILE 3
1609 #define CONFIG_NO_WRITE 4
1610 #define CONFIG_NOTHING_SET 5
1611 #define CONFIG_INVALID_PATTERN 6
1612 #define CONFIG_GENERIC_ERROR 7
1613
1614 #define CONFIG_REGEX_NONE ((void *)1)
1615
1616 struct git_config_source {
1617 unsigned int use_stdin:1;
1618 const char *file;
1619 const char *blob;
1620 };
1621
1622 enum config_origin_type {
1623 CONFIG_ORIGIN_BLOB,
1624 CONFIG_ORIGIN_FILE,
1625 CONFIG_ORIGIN_STDIN,
1626 CONFIG_ORIGIN_SUBMODULE_BLOB,
1627 CONFIG_ORIGIN_CMDLINE
1628 };
1629
1630 typedef int (*config_fn_t)(const char *, const char *, void *);
1631 extern int git_default_config(const char *, const char *, void *);
1632 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1633 extern int git_config_from_mem(config_fn_t fn, const enum config_origin_type,
1634 const char *name, const char *buf, size_t len, void *data);
1635 extern void git_config_push_parameter(const char *text);
1636 extern int git_config_from_parameters(config_fn_t fn, void *data);
1637 extern void git_config(config_fn_t fn, void *);
1638 extern int git_config_with_options(config_fn_t fn, void *,
1639 struct git_config_source *config_source,
1640 int respect_includes);
1641 extern int git_parse_ulong(const char *, unsigned long *);
1642 extern int git_parse_maybe_bool(const char *);
1643 extern int git_config_int(const char *, const char *);
1644 extern int64_t git_config_int64(const char *, const char *);
1645 extern unsigned long git_config_ulong(const char *, const char *);
1646 extern int git_config_bool_or_int(const char *, const char *, int *);
1647 extern int git_config_bool(const char *, const char *);
1648 extern int git_config_maybe_bool(const char *, const char *);
1649 extern int git_config_string(const char **, const char *, const char *);
1650 extern int git_config_pathname(const char **, const char *, const char *);
1651 extern int git_config_set_in_file_gently(const char *, const char *, const char *);
1652 extern void git_config_set_in_file(const char *, const char *, const char *);
1653 extern int git_config_set_gently(const char *, const char *);
1654 extern void git_config_set(const char *, const char *);
1655 extern int git_config_parse_key(const char *, char **, int *);
1656 extern int git_config_key_is_valid(const char *key);
1657 extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);
1658 extern void git_config_set_multivar(const char *, const char *, const char *, int);
1659 extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
1660 extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1661 extern int git_config_rename_section(const char *, const char *);
1662 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1663 extern const char *git_etc_gitconfig(void);
1664 extern int git_env_bool(const char *, int);
1665 extern unsigned long git_env_ulong(const char *, unsigned long);
1666 extern int git_config_system(void);
1667 extern int config_error_nonbool(const char *);
1668 #if defined(__GNUC__)
1669 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1670 #endif
1671 extern const char *get_log_output_encoding(void);
1672 extern const char *get_commit_output_encoding(void);
1673
1674 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1675
1676 enum config_scope {
1677 CONFIG_SCOPE_UNKNOWN = 0,
1678 CONFIG_SCOPE_SYSTEM,
1679 CONFIG_SCOPE_GLOBAL,
1680 CONFIG_SCOPE_REPO,
1681 CONFIG_SCOPE_CMDLINE,
1682 };
1683
1684 extern enum config_scope current_config_scope(void);
1685 extern const char *current_config_origin_type(void);
1686 extern const char *current_config_name(void);
1687
1688 struct config_include_data {
1689 int depth;
1690 config_fn_t fn;
1691 void *data;
1692 };
1693 #define CONFIG_INCLUDE_INIT { 0 }
1694 extern int git_config_include(const char *name, const char *value, void *data);
1695
1696 /*
1697 * Match and parse a config key of the form:
1698 *
1699 * section.(subsection.)?key
1700 *
1701 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1702 * we return -1 if it does not match, 0 otherwise. The subsection and key
1703 * out-parameters are filled by the function (and subsection is NULL if it is
1704 * missing).
1705 */
1706 extern int parse_config_key(const char *var,
1707 const char *section,
1708 const char **subsection, int *subsection_len,
1709 const char **key);
1710
1711 struct config_set_element {
1712 struct hashmap_entry ent;
1713 char *key;
1714 struct string_list value_list;
1715 };
1716
1717 struct configset_list_item {
1718 struct config_set_element *e;
1719 int value_index;
1720 };
1721
1722 /*
1723 * the contents of the list are ordered according to their
1724 * position in the config files and order of parsing the files.
1725 * (i.e. key-value pair at the last position of .git/config will
1726 * be at the last item of the list)
1727 */
1728 struct configset_list {
1729 struct configset_list_item *items;
1730 unsigned int nr, alloc;
1731 };
1732
1733 struct config_set {
1734 struct hashmap config_hash;
1735 int hash_initialized;
1736 struct configset_list list;
1737 };
1738
1739 extern void git_configset_init(struct config_set *cs);
1740 extern int git_configset_add_file(struct config_set *cs, const char *filename);
1741 extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
1742 extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
1743 extern void git_configset_clear(struct config_set *cs);
1744 extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
1745 extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
1746 extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
1747 extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
1748 extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
1749 extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
1750 extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
1751 extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
1752
1753 extern int git_config_get_value(const char *key, const char **value);
1754 extern const struct string_list *git_config_get_value_multi(const char *key);
1755 extern void git_config_clear(void);
1756 extern void git_config_iter(config_fn_t fn, void *data);
1757 extern int git_config_get_string_const(const char *key, const char **dest);
1758 extern int git_config_get_string(const char *key, char **dest);
1759 extern int git_config_get_int(const char *key, int *dest);
1760 extern int git_config_get_ulong(const char *key, unsigned long *dest);
1761 extern int git_config_get_bool(const char *key, int *dest);
1762 extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
1763 extern int git_config_get_maybe_bool(const char *key, int *dest);
1764 extern int git_config_get_pathname(const char *key, const char **dest);
1765 extern int git_config_get_untracked_cache(void);
1766
1767 /*
1768 * This is a hack for test programs like test-dump-untracked-cache to
1769 * ensure that they do not modify the untracked cache when reading it.
1770 * Do not use it otherwise!
1771 */
1772 extern int ignore_untracked_cache_config;
1773
1774 struct key_value_info {
1775 const char *filename;
1776 int linenr;
1777 enum config_origin_type origin_type;
1778 enum config_scope scope;
1779 };
1780
1781 extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
1782 extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
1783
1784 extern int committer_ident_sufficiently_given(void);
1785 extern int author_ident_sufficiently_given(void);
1786
1787 extern const char *git_commit_encoding;
1788 extern const char *git_log_output_encoding;
1789 extern const char *git_mailmap_file;
1790 extern const char *git_mailmap_blob;
1791
1792 /* IO helper functions */
1793 extern void maybe_flush_or_die(FILE *, const char *);
1794 __attribute__((format (printf, 2, 3)))
1795 extern void fprintf_or_die(FILE *, const char *fmt, ...);
1796
1797 #define COPY_READ_ERROR (-2)
1798 #define COPY_WRITE_ERROR (-3)
1799 extern int copy_fd(int ifd, int ofd);
1800 extern int copy_file(const char *dst, const char *src, int mode);
1801 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1802
1803 extern void write_or_die(int fd, const void *buf, size_t count);
1804 extern void fsync_or_die(int fd, const char *);
1805
1806 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1807 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1808 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1809
1810 static inline ssize_t write_str_in_full(int fd, const char *str)
1811 {
1812 return write_in_full(fd, str, strlen(str));
1813 }
1814
1815 /**
1816 * Open (and truncate) the file at path, write the contents of buf to it,
1817 * and close it. Dies if any errors are encountered.
1818 */
1819 extern void write_file_buf(const char *path, const char *buf, size_t len);
1820
1821 /**
1822 * Like write_file_buf(), but format the contents into a buffer first.
1823 * Additionally, write_file() will append a newline if one is not already
1824 * present, making it convenient to write text files:
1825 *
1826 * write_file(path, "counter: %d", ctr);
1827 */
1828 __attribute__((format (printf, 2, 3)))
1829 extern void write_file(const char *path, const char *fmt, ...);
1830
1831 /* pager.c */
1832 extern void setup_pager(void);
1833 extern int pager_in_use(void);
1834 extern int pager_use_color;
1835 extern int term_columns(void);
1836 extern int decimal_width(uintmax_t);
1837 extern int check_pager_config(const char *cmd);
1838 extern void prepare_pager_args(struct child_process *, const char *pager);
1839
1840 extern const char *editor_program;
1841 extern const char *askpass_program;
1842 extern const char *excludes_file;
1843
1844 /* base85 */
1845 int decode_85(char *dst, const char *line, int linelen);
1846 void encode_85(char *buf, const unsigned char *data, int bytes);
1847
1848 /* alloc.c */
1849 extern void *alloc_blob_node(void);
1850 extern void *alloc_tree_node(void);
1851 extern void *alloc_commit_node(void);
1852 extern void *alloc_tag_node(void);
1853 extern void *alloc_object_node(void);
1854 extern void alloc_report(void);
1855 extern unsigned int alloc_commit_index(void);
1856
1857 /* pkt-line.c */
1858 void packet_trace_identity(const char *prog);
1859
1860 /* add */
1861 /*
1862 * return 0 if success, 1 - if addition of a file failed and
1863 * ADD_FILES_IGNORE_ERRORS was specified in flags
1864 */
1865 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1866
1867 /* diff.c */
1868 extern int diff_auto_refresh_index;
1869
1870 /* match-trees.c */
1871 void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);
1872 void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);
1873
1874 /*
1875 * whitespace rules.
1876 * used by both diff and apply
1877 * last two digits are tab width
1878 */
1879 #define WS_BLANK_AT_EOL 0100
1880 #define WS_SPACE_BEFORE_TAB 0200
1881 #define WS_INDENT_WITH_NON_TAB 0400
1882 #define WS_CR_AT_EOL 01000
1883 #define WS_BLANK_AT_EOF 02000
1884 #define WS_TAB_IN_INDENT 04000
1885 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1886 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1887 #define WS_TAB_WIDTH_MASK 077
1888 extern unsigned whitespace_rule_cfg;
1889 extern unsigned whitespace_rule(const char *);
1890 extern unsigned parse_whitespace_rule(const char *);
1891 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1892 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1893 extern char *whitespace_error_string(unsigned ws);
1894 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1895 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1896 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1897
1898 /* ls-files */
1899 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1900
1901 char *alias_lookup(const char *alias);
1902 int split_cmdline(char *cmdline, const char ***argv);
1903 /* Takes a negative value returned by split_cmdline */
1904 const char *split_cmdline_strerror(int cmdline_errno);
1905
1906 /* setup.c */
1907 struct startup_info {
1908 int have_repository;
1909 const char *prefix;
1910 };
1911 extern struct startup_info *startup_info;
1912
1913 /* merge.c */
1914 struct commit_list;
1915 int try_merge_command(const char *strategy, size_t xopts_nr,
1916 const char **xopts, struct commit_list *common,
1917 const char *head_arg, struct commit_list *remotes);
1918 int checkout_fast_forward(const unsigned char *from,
1919 const unsigned char *to,
1920 int overwrite_ignore);
1921
1922
1923 int sane_execvp(const char *file, char *const argv[]);
1924
1925 /*
1926 * A struct to encapsulate the concept of whether a file has changed
1927 * since we last checked it. This uses criteria similar to those used
1928 * for the index.
1929 */
1930 struct stat_validity {
1931 struct stat_data *sd;
1932 };
1933
1934 void stat_validity_clear(struct stat_validity *sv);
1935
1936 /*
1937 * Returns 1 if the path is a regular file (or a symlink to a regular
1938 * file) and matches the saved stat_validity, 0 otherwise. A missing
1939 * or inaccessible file is considered a match if the struct was just
1940 * initialized, or if the previous update found an inaccessible file.
1941 */
1942 int stat_validity_check(struct stat_validity *sv, const char *path);
1943
1944 /*
1945 * Update the stat_validity from a file opened at descriptor fd. If
1946 * the file is missing, inaccessible, or not a regular file, then
1947 * future calls to stat_validity_check will match iff one of those
1948 * conditions continues to be true.
1949 */
1950 void stat_validity_update(struct stat_validity *sv, int fd);
1951
1952 int versioncmp(const char *s1, const char *s2);
1953 void sleep_millisec(int millisec);
1954
1955 /*
1956 * Create a directory and (if share is nonzero) adjust its permissions
1957 * according to the shared_repository setting. Only use this for
1958 * directories under $GIT_DIR. Don't use it for working tree
1959 * directories.
1960 */
1961 void safe_create_dir(const char *dir, int share);
1962
1963 #endif /* CACHE_H */