submodule: prevent backslash expantion in submodule names
[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 #include "hash.h"
14
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 int test_lazy_init_name_hash(struct index_state *istate, int try_threaded);
347 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
348 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
349 extern void free_name_hash(struct index_state *istate);
350
351
352 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
353 #define active_cache (the_index.cache)
354 #define active_nr (the_index.cache_nr)
355 #define active_alloc (the_index.cache_alloc)
356 #define active_cache_changed (the_index.cache_changed)
357 #define active_cache_tree (the_index.cache_tree)
358
359 #define read_cache() read_index(&the_index)
360 #define read_cache_from(path) read_index_from(&the_index, (path))
361 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
362 #define is_cache_unborn() is_index_unborn(&the_index)
363 #define read_cache_unmerged() read_index_unmerged(&the_index)
364 #define discard_cache() discard_index(&the_index)
365 #define unmerged_cache() unmerged_index(&the_index)
366 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
367 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
368 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
369 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
370 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
371 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
372 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
373 #define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
374 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
375 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
376 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
377 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
378 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
379 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
380 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
381 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
382 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
383 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
384 #endif
385
386 enum object_type {
387 OBJ_BAD = -1,
388 OBJ_NONE = 0,
389 OBJ_COMMIT = 1,
390 OBJ_TREE = 2,
391 OBJ_BLOB = 3,
392 OBJ_TAG = 4,
393 /* 5 for future expansion */
394 OBJ_OFS_DELTA = 6,
395 OBJ_REF_DELTA = 7,
396 OBJ_ANY,
397 OBJ_MAX
398 };
399
400 static inline enum object_type object_type(unsigned int mode)
401 {
402 return S_ISDIR(mode) ? OBJ_TREE :
403 S_ISGITLINK(mode) ? OBJ_COMMIT :
404 OBJ_BLOB;
405 }
406
407 /* Double-check local_repo_env below if you add to this list. */
408 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
409 #define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
410 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
411 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
412 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
413 #define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
414 #define GIT_TOPLEVEL_PREFIX_ENVIRONMENT "GIT_INTERNAL_TOPLEVEL_PREFIX"
415 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
416 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
417 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
418 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
419 #define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
420 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
421 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
422 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
423 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
424 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
425 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
426 #define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
427 #define GITATTRIBUTES_FILE ".gitattributes"
428 #define INFOATTRIBUTES_FILE "info/attributes"
429 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
430 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
431 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
432 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
433 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
434 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
435 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
436 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
437 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
438 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
439 #define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
440
441 /*
442 * This environment variable is expected to contain a boolean indicating
443 * whether we should or should not treat:
444 *
445 * GIT_DIR=foo.git git ...
446 *
447 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
448 * of this, but we use it internally to communicate to sub-processes that we
449 * are in a bare repo. If not set, defaults to true.
450 */
451 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
452
453 /*
454 * Repository-local GIT_* environment variables; these will be cleared
455 * when git spawns a sub-process that runs inside another repository.
456 * The array is NULL-terminated, which makes it easy to pass in the "env"
457 * parameter of a run-command invocation, or to do a simple walk.
458 */
459 extern const char * const local_repo_env[];
460
461 /*
462 * Returns true iff we have a configured git repository (either via
463 * setup_git_directory, or in the environment via $GIT_DIR).
464 */
465 int have_git_dir(void);
466
467 extern int is_bare_repository_cfg;
468 extern int is_bare_repository(void);
469 extern int is_inside_git_dir(void);
470 extern char *git_work_tree_cfg;
471 extern int is_inside_work_tree(void);
472 extern const char *get_git_dir(void);
473 extern const char *get_git_common_dir(void);
474 extern char *get_object_directory(void);
475 extern char *get_index_file(void);
476 extern char *get_graft_file(void);
477 extern int set_git_dir(const char *path);
478 extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
479 extern int get_common_dir(struct strbuf *sb, const char *gitdir);
480 extern const char *get_git_namespace(void);
481 extern const char *strip_namespace(const char *namespaced_ref);
482 extern const char *get_super_prefix(void);
483 extern const char *get_git_work_tree(void);
484
485 /*
486 * Return true if the given path is a git directory; note that this _just_
487 * looks at the directory itself. If you want to know whether "foo/.git"
488 * is a repository, you must feed that path, not just "foo".
489 */
490 extern int is_git_directory(const char *path);
491
492 /*
493 * Return 1 if the given path is the root of a git repository or
494 * submodule, else 0. Will not return 1 for bare repositories with the
495 * exception of creating a bare repository in "foo/.git" and calling
496 * is_git_repository("foo").
497 *
498 * If we run into read errors, we err on the side of saying "yes, it is",
499 * as we usually consider sub-repos precious, and would prefer to err on the
500 * side of not disrupting or deleting them.
501 */
502 extern int is_nonbare_repository_dir(struct strbuf *path);
503
504 #define READ_GITFILE_ERR_STAT_FAILED 1
505 #define READ_GITFILE_ERR_NOT_A_FILE 2
506 #define READ_GITFILE_ERR_OPEN_FAILED 3
507 #define READ_GITFILE_ERR_READ_FAILED 4
508 #define READ_GITFILE_ERR_INVALID_FORMAT 5
509 #define READ_GITFILE_ERR_NO_PATH 6
510 #define READ_GITFILE_ERR_NOT_A_REPO 7
511 #define READ_GITFILE_ERR_TOO_LARGE 8
512 extern void read_gitfile_error_die(int error_code, const char *path, const char *dir);
513 extern const char *read_gitfile_gently(const char *path, int *return_error_code);
514 #define read_gitfile(path) read_gitfile_gently((path), NULL)
515 extern const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
516 #define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
517
518 extern void set_git_work_tree(const char *tree);
519
520 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
521
522 extern void setup_work_tree(void);
523 /*
524 * Find GIT_DIR of the repository that contains the current working directory,
525 * without changing the working directory or other global state. The result is
526 * appended to gitdir. The return value is either NULL if no repository was
527 * found, or pointing to the path inside gitdir's buffer.
528 */
529 extern const char *discover_git_directory(struct strbuf *gitdir);
530 extern const char *setup_git_directory_gently(int *);
531 extern const char *setup_git_directory(void);
532 extern char *prefix_path(const char *prefix, int len, const char *path);
533 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
534
535 /*
536 * Concatenate "prefix" (if len is non-zero) and "path", with no
537 * connecting characters (so "prefix" should end with a "/").
538 * Unlike prefix_path, this should be used if the named file does
539 * not have to interact with index entry; i.e. name of a random file
540 * on the filesystem.
541 *
542 * The return value is always a newly allocated string (even if the
543 * prefix was empty).
544 */
545 extern char *prefix_filename(const char *prefix, const char *path);
546
547 extern int check_filename(const char *prefix, const char *name);
548 extern void verify_filename(const char *prefix,
549 const char *name,
550 int diagnose_misspelt_rev);
551 extern void verify_non_filename(const char *prefix, const char *name);
552 extern int path_inside_repo(const char *prefix, const char *path);
553
554 #define INIT_DB_QUIET 0x0001
555 #define INIT_DB_EXIST_OK 0x0002
556
557 extern int init_db(const char *git_dir, const char *real_git_dir,
558 const char *template_dir, unsigned int flags);
559
560 extern void sanitize_stdfds(void);
561 extern int daemonize(void);
562
563 #define alloc_nr(x) (((x)+16)*3/2)
564
565 /*
566 * Realloc the buffer pointed at by variable 'x' so that it can hold
567 * at least 'nr' entries; the number of entries currently allocated
568 * is 'alloc', using the standard growing factor alloc_nr() macro.
569 *
570 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
571 */
572 #define ALLOC_GROW(x, nr, alloc) \
573 do { \
574 if ((nr) > alloc) { \
575 if (alloc_nr(alloc) < (nr)) \
576 alloc = (nr); \
577 else \
578 alloc = alloc_nr(alloc); \
579 REALLOC_ARRAY(x, alloc); \
580 } \
581 } while (0)
582
583 /* Initialize and use the cache information */
584 struct lock_file;
585 extern int read_index(struct index_state *);
586 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
587 extern int do_read_index(struct index_state *istate, const char *path,
588 int must_exist); /* for testting only! */
589 extern int read_index_from(struct index_state *, const char *path);
590 extern int is_index_unborn(struct index_state *);
591 extern int read_index_unmerged(struct index_state *);
592 #define COMMIT_LOCK (1 << 0)
593 #define CLOSE_LOCK (1 << 1)
594 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
595 extern int discard_index(struct index_state *);
596 extern int unmerged_index(const struct index_state *);
597 extern int verify_path(const char *path);
598 extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
599 extern void adjust_dirname_case(struct index_state *istate, char *name);
600 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
601
602 /*
603 * Searches for an entry defined by name and namelen in the given index.
604 * If the return value is positive (including 0) it is the position of an
605 * exact match. If the return value is negative, the negated value minus 1
606 * is the position where the entry would be inserted.
607 * Example: The current index consists of these files and its stages:
608 *
609 * b#0, d#0, f#1, f#3
610 *
611 * index_name_pos(&index, "a", 1) -> -1
612 * index_name_pos(&index, "b", 1) -> 0
613 * index_name_pos(&index, "c", 1) -> -2
614 * index_name_pos(&index, "d", 1) -> 1
615 * index_name_pos(&index, "e", 1) -> -3
616 * index_name_pos(&index, "f", 1) -> -3
617 * index_name_pos(&index, "g", 1) -> -5
618 */
619 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
620
621 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
622 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
623 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
624 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
625 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
626 #define ADD_CACHE_KEEP_CACHE_TREE 32 /* Do not invalidate cache-tree */
627 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
628 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
629
630 /* Remove entry, return true if there are more entries to go. */
631 extern int remove_index_entry_at(struct index_state *, int pos);
632
633 extern void remove_marked_cache_entries(struct index_state *istate);
634 extern int remove_file_from_index(struct index_state *, const char *path);
635 #define ADD_CACHE_VERBOSE 1
636 #define ADD_CACHE_PRETEND 2
637 #define ADD_CACHE_IGNORE_ERRORS 4
638 #define ADD_CACHE_IGNORE_REMOVAL 8
639 #define ADD_CACHE_INTENT 16
640 /*
641 * These two are used to add the contents of the file at path
642 * to the index, marking the working tree up-to-date by storing
643 * the cached stat info in the resulting cache entry. A caller
644 * that has already run lstat(2) on the path can call
645 * add_to_index(), and all others can call add_file_to_index();
646 * the latter will do necessary lstat(2) internally before
647 * calling the former.
648 */
649 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
650 extern int add_file_to_index(struct index_state *, const char *path, int flags);
651
652 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
653 extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
654 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
655 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
656 extern int index_name_is_other(const struct index_state *, const char *, int);
657 extern void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *);
658
659 /* do stat comparison even if CE_VALID is true */
660 #define CE_MATCH_IGNORE_VALID 01
661 /* do not check the contents but report dirty on racily-clean entries */
662 #define CE_MATCH_RACY_IS_DIRTY 02
663 /* do stat comparison even if CE_SKIP_WORKTREE is true */
664 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
665 /* ignore non-existent files during stat update */
666 #define CE_MATCH_IGNORE_MISSING 0x08
667 /* enable stat refresh */
668 #define CE_MATCH_REFRESH 0x10
669 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
670 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
671
672 #define HASH_WRITE_OBJECT 1
673 #define HASH_FORMAT_CHECK 2
674 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
675 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
676
677 /*
678 * Record to sd the data from st that we use to check whether a file
679 * might have changed.
680 */
681 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
682
683 /*
684 * Return 0 if st is consistent with a file not having been changed
685 * since sd was filled. If there are differences, return a
686 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
687 * INODE_CHANGED, and DATA_CHANGED.
688 */
689 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
690 extern int match_stat_data_racy(const struct index_state *istate,
691 const struct stat_data *sd, struct stat *st);
692
693 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
694
695 #define REFRESH_REALLY 0x0001 /* ignore_valid */
696 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
697 #define REFRESH_QUIET 0x0004 /* be quiet about it */
698 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
699 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
700 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
701 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
702 extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int);
703
704 extern void update_index_if_able(struct index_state *, struct lock_file *);
705
706 extern int hold_locked_index(struct lock_file *, int);
707 extern void set_alternate_index_output(const char *);
708
709 /* Environment bits from configuration mechanism */
710 extern int trust_executable_bit;
711 extern int trust_ctime;
712 extern int check_stat;
713 extern int quote_path_fully;
714 extern int has_symlinks;
715 extern int minimum_abbrev, default_abbrev;
716 extern int ignore_case;
717 extern int assume_unchanged;
718 extern int prefer_symlink_refs;
719 extern int warn_ambiguous_refs;
720 extern int warn_on_object_refname_ambiguity;
721 extern const char *apply_default_whitespace;
722 extern const char *apply_default_ignorewhitespace;
723 extern const char *git_attributes_file;
724 extern const char *git_hooks_path;
725 extern int zlib_compression_level;
726 extern int core_compression_level;
727 extern int pack_compression_level;
728 extern size_t packed_git_window_size;
729 extern size_t packed_git_limit;
730 extern size_t delta_base_cache_limit;
731 extern unsigned long big_file_threshold;
732 extern unsigned long pack_size_limit_cfg;
733
734 /*
735 * Accessors for the core.sharedrepository config which lazy-load the value
736 * from the config (if not already set). The "reset" function can be
737 * used to unset "set" or cached value, meaning that the value will be loaded
738 * fresh from the config file on the next call to get_shared_repository().
739 */
740 void set_shared_repository(int value);
741 int get_shared_repository(void);
742 void reset_shared_repository(void);
743
744 /*
745 * Do replace refs need to be checked this run? This variable is
746 * initialized to true unless --no-replace-object is used or
747 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
748 * commands that do not want replace references to be active. As an
749 * optimization it is also set to false if replace references have
750 * been sought but there were none.
751 */
752 extern int check_replace_refs;
753 extern char *git_replace_ref_base;
754
755 extern int fsync_object_files;
756 extern int core_preload_index;
757 extern int core_apply_sparse_checkout;
758 extern int precomposed_unicode;
759 extern int protect_hfs;
760 extern int protect_ntfs;
761 extern int git_db_env, git_index_env, git_graft_env, git_common_dir_env;
762
763 /*
764 * Include broken refs in all ref iterations, which will
765 * generally choke dangerous operations rather than letting
766 * them silently proceed without taking the broken ref into
767 * account.
768 */
769 extern int ref_paranoia;
770
771 /*
772 * The character that begins a commented line in user-editable file
773 * that is subject to stripspace.
774 */
775 extern char comment_line_char;
776 extern int auto_comment_line_char;
777
778 /* Windows only */
779 enum hide_dotfiles_type {
780 HIDE_DOTFILES_FALSE = 0,
781 HIDE_DOTFILES_TRUE,
782 HIDE_DOTFILES_DOTGITONLY
783 };
784 extern enum hide_dotfiles_type hide_dotfiles;
785
786 enum log_refs_config {
787 LOG_REFS_UNSET = -1,
788 LOG_REFS_NONE = 0,
789 LOG_REFS_NORMAL,
790 LOG_REFS_ALWAYS
791 };
792 extern enum log_refs_config log_all_ref_updates;
793
794 enum branch_track {
795 BRANCH_TRACK_UNSPECIFIED = -1,
796 BRANCH_TRACK_NEVER = 0,
797 BRANCH_TRACK_REMOTE,
798 BRANCH_TRACK_ALWAYS,
799 BRANCH_TRACK_EXPLICIT,
800 BRANCH_TRACK_OVERRIDE
801 };
802
803 enum rebase_setup_type {
804 AUTOREBASE_NEVER = 0,
805 AUTOREBASE_LOCAL,
806 AUTOREBASE_REMOTE,
807 AUTOREBASE_ALWAYS
808 };
809
810 enum push_default_type {
811 PUSH_DEFAULT_NOTHING = 0,
812 PUSH_DEFAULT_MATCHING,
813 PUSH_DEFAULT_SIMPLE,
814 PUSH_DEFAULT_UPSTREAM,
815 PUSH_DEFAULT_CURRENT,
816 PUSH_DEFAULT_UNSPECIFIED
817 };
818
819 extern enum branch_track git_branch_track;
820 extern enum rebase_setup_type autorebase;
821 extern enum push_default_type push_default;
822
823 enum object_creation_mode {
824 OBJECT_CREATION_USES_HARDLINKS = 0,
825 OBJECT_CREATION_USES_RENAMES = 1
826 };
827
828 extern enum object_creation_mode object_creation_mode;
829
830 extern char *notes_ref_name;
831
832 extern int grafts_replace_parents;
833
834 /*
835 * GIT_REPO_VERSION is the version we write by default. The
836 * _READ variant is the highest number we know how to
837 * handle.
838 */
839 #define GIT_REPO_VERSION 0
840 #define GIT_REPO_VERSION_READ 1
841 extern int repository_format_precious_objects;
842
843 struct repository_format {
844 int version;
845 int precious_objects;
846 int is_bare;
847 char *work_tree;
848 struct string_list unknown_extensions;
849 };
850
851 /*
852 * Read the repository format characteristics from the config file "path" into
853 * "format" struct. Returns the numeric version. On error, -1 is returned,
854 * format->version is set to -1, and all other fields in the struct are
855 * undefined.
856 */
857 int read_repository_format(struct repository_format *format, const char *path);
858
859 /*
860 * Verify that the repository described by repository_format is something we
861 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
862 * any errors encountered.
863 */
864 int verify_repository_format(const struct repository_format *format,
865 struct strbuf *err);
866
867 /*
868 * Check the repository format version in the path found in get_git_dir(),
869 * and die if it is a version we don't understand. Generally one would
870 * set_git_dir() before calling this, and use it only for "are we in a valid
871 * repo?".
872 */
873 extern void check_repository_format(void);
874
875 #define MTIME_CHANGED 0x0001
876 #define CTIME_CHANGED 0x0002
877 #define OWNER_CHANGED 0x0004
878 #define MODE_CHANGED 0x0008
879 #define INODE_CHANGED 0x0010
880 #define DATA_CHANGED 0x0020
881 #define TYPE_CHANGED 0x0040
882
883 /*
884 * Return a statically allocated filename, either generically (mkpath), in
885 * the repository directory (git_path), or in a submodule's repository
886 * directory (git_path_submodule). In all cases, note that the result
887 * may be overwritten by another call to _any_ of the functions. Consider
888 * using the safer "dup" or "strbuf" formats below (in some cases, the
889 * unsafe versions have already been removed).
890 */
891 extern const char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
892 extern const char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
893 extern const char *git_common_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
894
895 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
896 __attribute__((format (printf, 3, 4)));
897 extern void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
898 __attribute__((format (printf, 2, 3)));
899 extern void strbuf_git_common_path(struct strbuf *sb, const char *fmt, ...)
900 __attribute__((format (printf, 2, 3)));
901 extern char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
902 __attribute__((format (printf, 2, 3)));
903 extern int strbuf_git_path_submodule(struct strbuf *sb, const char *path,
904 const char *fmt, ...)
905 __attribute__((format (printf, 3, 4)));
906 extern char *git_pathdup(const char *fmt, ...)
907 __attribute__((format (printf, 1, 2)));
908 extern char *mkpathdup(const char *fmt, ...)
909 __attribute__((format (printf, 1, 2)));
910 extern char *git_pathdup_submodule(const char *path, const char *fmt, ...)
911 __attribute__((format (printf, 2, 3)));
912
913 extern void report_linked_checkout_garbage(void);
914
915 /*
916 * You can define a static memoized git path like:
917 *
918 * static GIT_PATH_FUNC(git_path_foo, "FOO");
919 *
920 * or use one of the global ones below.
921 */
922 #define GIT_PATH_FUNC(func, filename) \
923 const char *func(void) \
924 { \
925 static char *ret; \
926 if (!ret) \
927 ret = git_pathdup(filename); \
928 return ret; \
929 }
930
931 const char *git_path_cherry_pick_head(void);
932 const char *git_path_revert_head(void);
933 const char *git_path_squash_msg(void);
934 const char *git_path_merge_msg(void);
935 const char *git_path_merge_rr(void);
936 const char *git_path_merge_mode(void);
937 const char *git_path_merge_head(void);
938 const char *git_path_fetch_head(void);
939 const char *git_path_shallow(void);
940
941 /*
942 * Return the name of the file in the local object database that would
943 * be used to store a loose object with the specified sha1. The
944 * return value is a pointer to a statically allocated buffer that is
945 * overwritten each time the function is called.
946 */
947 extern const char *sha1_file_name(const unsigned char *sha1);
948
949 /*
950 * Return the name of the (local) packfile with the specified sha1 in
951 * its name. The return value is a pointer to memory that is
952 * overwritten each time this function is called.
953 */
954 extern char *sha1_pack_name(const unsigned char *sha1);
955
956 /*
957 * Return the name of the (local) pack index file with the specified
958 * sha1 in its name. The return value is a pointer to memory that is
959 * overwritten each time this function is called.
960 */
961 extern char *sha1_pack_index_name(const unsigned char *sha1);
962
963 /*
964 * Return an abbreviated sha1 unique within this repository's object database.
965 * The result will be at least `len` characters long, and will be NUL
966 * terminated.
967 *
968 * The non-`_r` version returns a static buffer which remains valid until 4
969 * more calls to find_unique_abbrev are made.
970 *
971 * The `_r` variant writes to a buffer supplied by the caller, which must be at
972 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
973 * written (excluding the NUL terminator).
974 *
975 * Note that while this version avoids the static buffer, it is not fully
976 * reentrant, as it calls into other non-reentrant git code.
977 */
978 extern const char *find_unique_abbrev(const unsigned char *sha1, int len);
979 extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len);
980
981 extern const unsigned char null_sha1[GIT_SHA1_RAWSZ];
982 extern const struct object_id null_oid;
983
984 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
985 {
986 int i;
987
988 for (i = 0; i < GIT_SHA1_RAWSZ; i++, sha1++, sha2++) {
989 if (*sha1 != *sha2)
990 return *sha1 - *sha2;
991 }
992
993 return 0;
994 }
995
996 static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
997 {
998 return hashcmp(oid1->hash, oid2->hash);
999 }
1000
1001 static inline int is_null_sha1(const unsigned char *sha1)
1002 {
1003 return !hashcmp(sha1, null_sha1);
1004 }
1005
1006 static inline int is_null_oid(const struct object_id *oid)
1007 {
1008 return !hashcmp(oid->hash, null_sha1);
1009 }
1010
1011 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
1012 {
1013 memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
1014 }
1015
1016 static inline void oidcpy(struct object_id *dst, const struct object_id *src)
1017 {
1018 hashcpy(dst->hash, src->hash);
1019 }
1020
1021 static inline void hashclr(unsigned char *hash)
1022 {
1023 memset(hash, 0, GIT_SHA1_RAWSZ);
1024 }
1025
1026 static inline void oidclr(struct object_id *oid)
1027 {
1028 hashclr(oid->hash);
1029 }
1030
1031
1032 #define EMPTY_TREE_SHA1_HEX \
1033 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
1034 #define EMPTY_TREE_SHA1_BIN_LITERAL \
1035 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
1036 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
1037 extern const struct object_id empty_tree_oid;
1038 #define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)
1039
1040 #define EMPTY_BLOB_SHA1_HEX \
1041 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
1042 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
1043 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
1044 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
1045 extern const struct object_id empty_blob_oid;
1046 #define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)
1047
1048
1049 static inline int is_empty_blob_sha1(const unsigned char *sha1)
1050 {
1051 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
1052 }
1053
1054 static inline int is_empty_blob_oid(const struct object_id *oid)
1055 {
1056 return !hashcmp(oid->hash, EMPTY_BLOB_SHA1_BIN);
1057 }
1058
1059 static inline int is_empty_tree_sha1(const unsigned char *sha1)
1060 {
1061 return !hashcmp(sha1, EMPTY_TREE_SHA1_BIN);
1062 }
1063
1064 static inline int is_empty_tree_oid(const struct object_id *oid)
1065 {
1066 return !hashcmp(oid->hash, EMPTY_TREE_SHA1_BIN);
1067 }
1068
1069 /* set default permissions by passing mode arguments to open(2) */
1070 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
1071 int git_mkstemp_mode(char *pattern, int mode);
1072
1073 /*
1074 * NOTE NOTE NOTE!!
1075 *
1076 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1077 * not be changed. Old repositories have core.sharedrepository written in
1078 * numeric format, and therefore these values are preserved for compatibility
1079 * reasons.
1080 */
1081 enum sharedrepo {
1082 PERM_UMASK = 0,
1083 OLD_PERM_GROUP = 1,
1084 OLD_PERM_EVERYBODY = 2,
1085 PERM_GROUP = 0660,
1086 PERM_EVERYBODY = 0664
1087 };
1088 int git_config_perm(const char *var, const char *value);
1089 int adjust_shared_perm(const char *path);
1090
1091 /*
1092 * Create the directory containing the named path, using care to be
1093 * somewhat safe against races. Return one of the scld_error values to
1094 * indicate success/failure. On error, set errno to describe the
1095 * problem.
1096 *
1097 * SCLD_VANISHED indicates that one of the ancestor directories of the
1098 * path existed at one point during the function call and then
1099 * suddenly vanished, probably because another process pruned the
1100 * directory while we were working. To be robust against this kind of
1101 * race, callers might want to try invoking the function again when it
1102 * returns SCLD_VANISHED.
1103 *
1104 * safe_create_leading_directories() temporarily changes path while it
1105 * is working but restores it before returning.
1106 * safe_create_leading_directories_const() doesn't modify path, even
1107 * temporarily.
1108 */
1109 enum scld_error {
1110 SCLD_OK = 0,
1111 SCLD_FAILED = -1,
1112 SCLD_PERMS = -2,
1113 SCLD_EXISTS = -3,
1114 SCLD_VANISHED = -4
1115 };
1116 enum scld_error safe_create_leading_directories(char *path);
1117 enum scld_error safe_create_leading_directories_const(const char *path);
1118
1119 /*
1120 * Callback function for raceproof_create_file(). This function is
1121 * expected to do something that makes dirname(path) permanent despite
1122 * the fact that other processes might be cleaning up empty
1123 * directories at the same time. Usually it will create a file named
1124 * path, but alternatively it could create another file in that
1125 * directory, or even chdir() into that directory. The function should
1126 * return 0 if the action was completed successfully. On error, it
1127 * should return a nonzero result and set errno.
1128 * raceproof_create_file() treats two errno values specially:
1129 *
1130 * - ENOENT -- dirname(path) does not exist. In this case,
1131 * raceproof_create_file() tries creating dirname(path)
1132 * (and any parent directories, if necessary) and calls
1133 * the function again.
1134 *
1135 * - EISDIR -- the file already exists and is a directory. In this
1136 * case, raceproof_create_file() removes the directory if
1137 * it is empty (and recursively any empty directories that
1138 * it contains) and calls the function again.
1139 *
1140 * Any other errno causes raceproof_create_file() to fail with the
1141 * callback's return value and errno.
1142 *
1143 * Obviously, this function should be OK with being called again if it
1144 * fails with ENOENT or EISDIR. In other scenarios it will not be
1145 * called again.
1146 */
1147 typedef int create_file_fn(const char *path, void *cb);
1148
1149 /*
1150 * Create a file in dirname(path) by calling fn, creating leading
1151 * directories if necessary. Retry a few times in case we are racing
1152 * with another process that is trying to clean up the directory that
1153 * contains path. See the documentation for create_file_fn for more
1154 * details.
1155 *
1156 * Return the value and set the errno that resulted from the most
1157 * recent call of fn. fn is always called at least once, and will be
1158 * called more than once if it returns ENOENT or EISDIR.
1159 */
1160 int raceproof_create_file(const char *path, create_file_fn fn, void *cb);
1161
1162 int mkdir_in_gitdir(const char *path);
1163 extern char *expand_user_path(const char *path);
1164 const char *enter_repo(const char *path, int strict);
1165 static inline int is_absolute_path(const char *path)
1166 {
1167 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
1168 }
1169 int is_directory(const char *);
1170 char *strbuf_realpath(struct strbuf *resolved, const char *path,
1171 int die_on_error);
1172 const char *real_path(const char *path);
1173 const char *real_path_if_valid(const char *path);
1174 char *real_pathdup(const char *path, int die_on_error);
1175 const char *absolute_path(const char *path);
1176 char *absolute_pathdup(const char *path);
1177 const char *remove_leading_path(const char *in, const char *prefix);
1178 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
1179 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
1180 int normalize_path_copy(char *dst, const char *src);
1181 int longest_ancestor_length(const char *path, struct string_list *prefixes);
1182 char *strip_path_suffix(const char *path, const char *suffix);
1183 int daemon_avoid_alias(const char *path);
1184 extern int is_ntfs_dotgit(const char *name);
1185
1186 /**
1187 * Return a newly allocated string with the evaluation of
1188 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1189 * "$HOME/.config/git/$filename". Return NULL upon error.
1190 */
1191 extern char *xdg_config_home(const char *filename);
1192
1193 /**
1194 * Return a newly allocated string with the evaluation of
1195 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
1196 * "$HOME/.cache/git/$filename". Return NULL upon error.
1197 */
1198 extern char *xdg_cache_home(const char *filename);
1199
1200 /* object replacement */
1201 #define LOOKUP_REPLACE_OBJECT 1
1202 #define LOOKUP_UNKNOWN_OBJECT 2
1203 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
1204 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
1205 {
1206 return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
1207 }
1208
1209 /*
1210 * This internal function is only declared here for the benefit of
1211 * lookup_replace_object(). Please do not call it directly.
1212 */
1213 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
1214
1215 /*
1216 * If object sha1 should be replaced, return the replacement object's
1217 * name (replaced recursively, if necessary). The return value is
1218 * either sha1 or a pointer to a permanently-allocated value. When
1219 * object replacement is suppressed, always return sha1.
1220 */
1221 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1222 {
1223 if (!check_replace_refs)
1224 return sha1;
1225 return do_lookup_replace_object(sha1);
1226 }
1227
1228 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
1229 {
1230 if (!(flag & LOOKUP_REPLACE_OBJECT))
1231 return sha1;
1232 return lookup_replace_object(sha1);
1233 }
1234
1235 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
1236 extern int sha1_object_info(const unsigned char *, unsigned long *);
1237 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
1238 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
1239 extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, unsigned char *sha1, unsigned flags);
1240 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
1241 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
1242 extern int git_open_cloexec(const char *name, int flags);
1243 #define git_open(name) git_open_cloexec(name, O_RDONLY)
1244 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
1245 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
1246 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
1247
1248 /* global flag to enable extra checks when accessing packed objects */
1249 extern int do_check_packed_object_crc;
1250
1251 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
1252
1253 extern int finalize_object_file(const char *tmpfile, const char *filename);
1254
1255 extern int has_sha1_pack(const unsigned char *sha1);
1256
1257 /*
1258 * Open the loose object at path, check its sha1, and return the contents,
1259 * type, and size. If the object is a blob, then "contents" may return NULL,
1260 * to allow streaming of large blobs.
1261 *
1262 * Returns 0 on success, negative on error (details may be written to stderr).
1263 */
1264 int read_loose_object(const char *path,
1265 const unsigned char *expected_sha1,
1266 enum object_type *type,
1267 unsigned long *size,
1268 void **contents);
1269
1270 /*
1271 * Return true iff we have an object named sha1, whether local or in
1272 * an alternate object database, and whether packed or loose. This
1273 * function does not respect replace references.
1274 *
1275 * If the QUICK flag is set, do not re-check the pack directory
1276 * when we cannot find the object (this means we may give a false
1277 * negative answer if another process is simultaneously repacking).
1278 */
1279 #define HAS_SHA1_QUICK 0x1
1280 extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1281 static inline int has_sha1_file(const unsigned char *sha1)
1282 {
1283 return has_sha1_file_with_flags(sha1, 0);
1284 }
1285
1286 /* Same as the above, except for struct object_id. */
1287 extern int has_object_file(const struct object_id *oid);
1288 extern int has_object_file_with_flags(const struct object_id *oid, int flags);
1289
1290 /*
1291 * Return true iff an alternate object database has a loose object
1292 * with the specified name. This function does not respect replace
1293 * references.
1294 */
1295 extern int has_loose_object_nonlocal(const unsigned char *sha1);
1296
1297 extern int has_pack_index(const unsigned char *sha1);
1298
1299 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1300
1301 /* Helper to check and "touch" a file */
1302 extern int check_and_freshen_file(const char *fn, int freshen);
1303
1304 extern const signed char hexval_table[256];
1305 static inline unsigned int hexval(unsigned char c)
1306 {
1307 return hexval_table[c];
1308 }
1309
1310 /*
1311 * Convert two consecutive hexadecimal digits into a char. Return a
1312 * negative value on error. Don't run over the end of short strings.
1313 */
1314 static inline int hex2chr(const char *s)
1315 {
1316 int val = hexval(s[0]);
1317 return (val < 0) ? val : (val << 4) | hexval(s[1]);
1318 }
1319
1320 /* Convert to/from hex/sha1 representation */
1321 #define MINIMUM_ABBREV minimum_abbrev
1322 #define DEFAULT_ABBREV default_abbrev
1323
1324 /* used when the code does not know or care what the default abbrev is */
1325 #define FALLBACK_DEFAULT_ABBREV 7
1326
1327 struct object_context {
1328 unsigned char tree[20];
1329 char path[PATH_MAX];
1330 unsigned mode;
1331 /*
1332 * symlink_path is only used by get_tree_entry_follow_symlinks,
1333 * and only for symlinks that point outside the repository.
1334 */
1335 struct strbuf symlink_path;
1336 };
1337
1338 #define GET_SHA1_QUIETLY 01
1339 #define GET_SHA1_COMMIT 02
1340 #define GET_SHA1_COMMITTISH 04
1341 #define GET_SHA1_TREE 010
1342 #define GET_SHA1_TREEISH 020
1343 #define GET_SHA1_BLOB 040
1344 #define GET_SHA1_FOLLOW_SYMLINKS 0100
1345 #define GET_SHA1_ONLY_TO_DIE 04000
1346
1347 #define GET_SHA1_DISAMBIGUATORS \
1348 (GET_SHA1_COMMIT | GET_SHA1_COMMITTISH | \
1349 GET_SHA1_TREE | GET_SHA1_TREEISH | \
1350 GET_SHA1_BLOB)
1351
1352 extern int get_sha1(const char *str, unsigned char *sha1);
1353 extern int get_sha1_commit(const char *str, unsigned char *sha1);
1354 extern int get_sha1_committish(const char *str, unsigned char *sha1);
1355 extern int get_sha1_tree(const char *str, unsigned char *sha1);
1356 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
1357 extern int get_sha1_blob(const char *str, unsigned char *sha1);
1358 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1359 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
1360
1361 extern int get_oid(const char *str, struct object_id *oid);
1362
1363 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
1364 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1365
1366 extern int set_disambiguate_hint_config(const char *var, const char *value);
1367
1368 /*
1369 * Try to read a SHA1 in hexadecimal format from the 40 characters
1370 * starting at hex. Write the 20-byte result to sha1 in binary form.
1371 * Return 0 on success. Reading stops if a NUL is encountered in the
1372 * input, so it is safe to pass this function an arbitrary
1373 * null-terminated string.
1374 */
1375 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1376 extern int get_oid_hex(const char *hex, struct object_id *sha1);
1377
1378 /*
1379 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1380 * and writes the NUL-terminated output to the buffer `out`, which must be at
1381 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1382 * convenience.
1383 *
1384 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1385 * buffers, making it safe to make multiple calls for a single statement, like:
1386 *
1387 * printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1388 */
1389 extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
1390 extern char *oid_to_hex_r(char *out, const struct object_id *oid);
1391 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
1392 extern char *oid_to_hex(const struct object_id *oid); /* same static buffer as sha1_to_hex */
1393
1394 /*
1395 * Parse a 40-character hexadecimal object ID starting from hex, updating the
1396 * pointer specified by end when parsing stops. The resulting object ID is
1397 * stored in oid. Returns 0 on success. Parsing will stop on the first NUL or
1398 * other invalid character. end is only updated on success; otherwise, it is
1399 * unmodified.
1400 */
1401 extern int parse_oid_hex(const char *hex, struct object_id *oid, const char **end);
1402
1403 /*
1404 * This reads short-hand syntax that not only evaluates to a commit
1405 * object name, but also can act as if the end user spelled the name
1406 * of the branch from the command line.
1407 *
1408 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1409 * places the name of the branch in the given buf and returns the
1410 * number of characters parsed if successful.
1411 *
1412 * - "<branch>@{upstream}" finds the name of the other ref that
1413 * <branch> is configured to merge with (missing <branch> defaults
1414 * to the current branch), and places the name of the branch in the
1415 * given buf and returns the number of characters parsed if
1416 * successful.
1417 *
1418 * If the input is not of the accepted format, it returns a negative
1419 * number to signal an error.
1420 *
1421 * If the input was ok but there are not N branch switches in the
1422 * reflog, it returns 0.
1423 *
1424 * If "allowed" is non-zero, it is a treated as a bitfield of allowable
1425 * expansions: local branches ("refs/heads/"), remote branches
1426 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
1427 * allowed, even ones to refs outside of those namespaces.
1428 */
1429 #define INTERPRET_BRANCH_LOCAL (1<<0)
1430 #define INTERPRET_BRANCH_REMOTE (1<<1)
1431 #define INTERPRET_BRANCH_HEAD (1<<2)
1432 extern int interpret_branch_name(const char *str, int len, struct strbuf *,
1433 unsigned allowed);
1434 extern int get_oid_mb(const char *str, struct object_id *oid);
1435
1436 extern int validate_headref(const char *ref);
1437
1438 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1439 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1440 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1441 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1442
1443 extern void *read_object_with_reference(const unsigned char *sha1,
1444 const char *required_type,
1445 unsigned long *size,
1446 unsigned char *sha1_ret);
1447
1448 extern struct object *peel_to_type(const char *name, int namelen,
1449 struct object *o, enum object_type);
1450
1451 struct date_mode {
1452 enum date_mode_type {
1453 DATE_NORMAL = 0,
1454 DATE_RELATIVE,
1455 DATE_SHORT,
1456 DATE_ISO8601,
1457 DATE_ISO8601_STRICT,
1458 DATE_RFC2822,
1459 DATE_STRFTIME,
1460 DATE_RAW,
1461 DATE_UNIX
1462 } type;
1463 const char *strftime_fmt;
1464 int local;
1465 };
1466
1467 /*
1468 * Convenience helper for passing a constant type, like:
1469 *
1470 * show_date(t, tz, DATE_MODE(NORMAL));
1471 */
1472 #define DATE_MODE(t) date_mode_from_type(DATE_##t)
1473 struct date_mode *date_mode_from_type(enum date_mode_type type);
1474
1475 const char *show_date(unsigned long time, int timezone, const struct date_mode *mode);
1476 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1477 struct strbuf *timebuf);
1478 int parse_date(const char *date, struct strbuf *out);
1479 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
1480 int parse_expiry_date(const char *date, unsigned long *timestamp);
1481 void datestamp(struct strbuf *out);
1482 #define approxidate(s) approxidate_careful((s), NULL)
1483 unsigned long approxidate_careful(const char *, int *);
1484 unsigned long approxidate_relative(const char *date, const struct timeval *now);
1485 void parse_date_format(const char *format, struct date_mode *mode);
1486 int date_overflows(unsigned long date);
1487
1488 #define IDENT_STRICT 1
1489 #define IDENT_NO_DATE 2
1490 #define IDENT_NO_NAME 4
1491 extern const char *git_author_info(int);
1492 extern const char *git_committer_info(int);
1493 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1494 extern const char *fmt_name(const char *name, const char *email);
1495 extern const char *ident_default_name(void);
1496 extern const char *ident_default_email(void);
1497 extern const char *git_editor(void);
1498 extern const char *git_pager(int stdout_is_tty);
1499 extern int git_ident_config(const char *, const char *, void *);
1500 extern void reset_ident_date(void);
1501
1502 struct ident_split {
1503 const char *name_begin;
1504 const char *name_end;
1505 const char *mail_begin;
1506 const char *mail_end;
1507 const char *date_begin;
1508 const char *date_end;
1509 const char *tz_begin;
1510 const char *tz_end;
1511 };
1512 /*
1513 * Signals an success with 0, but time part of the result may be NULL
1514 * if the input lacks timestamp and zone
1515 */
1516 extern int split_ident_line(struct ident_split *, const char *, int);
1517
1518 /*
1519 * Like show_date, but pull the timestamp and tz parameters from
1520 * the ident_split. It will also sanity-check the values and produce
1521 * a well-known sentinel date if they appear bogus.
1522 */
1523 const char *show_ident_date(const struct ident_split *id,
1524 const struct date_mode *mode);
1525
1526 /*
1527 * Compare split idents for equality or strict ordering. Note that we
1528 * compare only the ident part of the line, ignoring any timestamp.
1529 *
1530 * Because there are two fields, we must choose one as the primary key; we
1531 * currently arbitrarily pick the email.
1532 */
1533 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1534
1535 struct checkout {
1536 struct index_state *istate;
1537 const char *base_dir;
1538 int base_dir_len;
1539 unsigned force:1,
1540 quiet:1,
1541 not_new:1,
1542 refresh_cache:1;
1543 };
1544 #define CHECKOUT_INIT { NULL, "" }
1545
1546 #define TEMPORARY_FILENAME_LENGTH 25
1547 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1548
1549 struct cache_def {
1550 struct strbuf path;
1551 int flags;
1552 int track_flags;
1553 int prefix_len_stat_func;
1554 };
1555 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1556 static inline void cache_def_clear(struct cache_def *cache)
1557 {
1558 strbuf_release(&cache->path);
1559 }
1560
1561 extern int has_symlink_leading_path(const char *name, int len);
1562 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1563 extern int check_leading_path(const char *name, int len);
1564 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1565 extern void schedule_dir_for_removal(const char *name, int len);
1566 extern void remove_scheduled_dirs(void);
1567
1568 extern struct alternate_object_database {
1569 struct alternate_object_database *next;
1570
1571 /* see alt_scratch_buf() */
1572 struct strbuf scratch;
1573 size_t base_len;
1574
1575 char path[FLEX_ARRAY];
1576 } *alt_odb_list;
1577 extern void prepare_alt_odb(void);
1578 extern void read_info_alternates(const char * relative_base, int depth);
1579 extern char *compute_alternate_path(const char *path, struct strbuf *err);
1580 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1581 extern int foreach_alt_odb(alt_odb_fn, void*);
1582
1583 /*
1584 * Allocate a "struct alternate_object_database" but do _not_ actually
1585 * add it to the list of alternates.
1586 */
1587 struct alternate_object_database *alloc_alt_odb(const char *dir);
1588
1589 /*
1590 * Add the directory to the on-disk alternates file; the new entry will also
1591 * take effect in the current process.
1592 */
1593 extern void add_to_alternates_file(const char *dir);
1594
1595 /*
1596 * Add the directory to the in-memory list of alternates (along with any
1597 * recursive alternates it points to), but do not modify the on-disk alternates
1598 * file.
1599 */
1600 extern void add_to_alternates_memory(const char *dir);
1601
1602 /*
1603 * Returns a scratch strbuf pre-filled with the alternate object directory,
1604 * including a trailing slash, which can be used to access paths in the
1605 * alternate. Always use this over direct access to alt->scratch, as it
1606 * cleans up any previous use of the scratch buffer.
1607 */
1608 extern struct strbuf *alt_scratch_buf(struct alternate_object_database *alt);
1609
1610 struct pack_window {
1611 struct pack_window *next;
1612 unsigned char *base;
1613 off_t offset;
1614 size_t len;
1615 unsigned int last_used;
1616 unsigned int inuse_cnt;
1617 };
1618
1619 extern struct packed_git {
1620 struct packed_git *next;
1621 struct pack_window *windows;
1622 off_t pack_size;
1623 const void *index_data;
1624 size_t index_size;
1625 uint32_t num_objects;
1626 uint32_t num_bad_objects;
1627 unsigned char *bad_object_sha1;
1628 int index_version;
1629 time_t mtime;
1630 int pack_fd;
1631 unsigned pack_local:1,
1632 pack_keep:1,
1633 freshened:1,
1634 do_not_close:1;
1635 unsigned char sha1[20];
1636 struct revindex_entry *revindex;
1637 /* something like ".git/objects/pack/xxxxx.pack" */
1638 char pack_name[FLEX_ARRAY]; /* more */
1639 } *packed_git;
1640
1641 /*
1642 * A most-recently-used ordered version of the packed_git list, which can
1643 * be iterated instead of packed_git (and marked via mru_mark).
1644 */
1645 struct mru;
1646 extern struct mru *packed_git_mru;
1647
1648 struct pack_entry {
1649 off_t offset;
1650 unsigned char sha1[20];
1651 struct packed_git *p;
1652 };
1653
1654 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1655
1656 /* A hook to report invalid files in pack directory */
1657 #define PACKDIR_FILE_PACK 1
1658 #define PACKDIR_FILE_IDX 2
1659 #define PACKDIR_FILE_GARBAGE 4
1660 extern void (*report_garbage)(unsigned seen_bits, const char *path);
1661
1662 extern void prepare_packed_git(void);
1663 extern void reprepare_packed_git(void);
1664 extern void install_packed_git(struct packed_git *pack);
1665
1666 /*
1667 * Give a rough count of objects in the repository. This sacrifices accuracy
1668 * for speed.
1669 */
1670 unsigned long approximate_object_count(void);
1671
1672 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1673 struct packed_git *packs);
1674
1675 extern void pack_report(void);
1676
1677 /*
1678 * Create a temporary file rooted in the object database directory.
1679 */
1680 extern int odb_mkstemp(char *template, size_t limit, const char *pattern);
1681
1682 /*
1683 * Generate the filename to be used for a pack file with checksum "sha1" and
1684 * extension "ext". The result is written into the strbuf "buf", overwriting
1685 * any existing contents. A pointer to buf->buf is returned as a convenience.
1686 *
1687 * Example: odb_pack_name(out, sha1, "idx") => ".git/objects/pack/pack-1234..idx"
1688 */
1689 extern char *odb_pack_name(struct strbuf *buf, const unsigned char *sha1, const char *ext);
1690
1691 /*
1692 * Create a pack .keep file named "name" (which should generally be the output
1693 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1694 * error.
1695 */
1696 extern int odb_pack_keep(const char *name);
1697
1698 /*
1699 * mmap the index file for the specified packfile (if it is not
1700 * already mmapped). Return 0 on success.
1701 */
1702 extern int open_pack_index(struct packed_git *);
1703
1704 /*
1705 * munmap the index file for the specified packfile (if it is
1706 * currently mmapped).
1707 */
1708 extern void close_pack_index(struct packed_git *);
1709
1710 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1711 extern void close_pack_windows(struct packed_git *);
1712 extern void close_all_packs(void);
1713 extern void unuse_pack(struct pack_window **);
1714 extern void clear_delta_base_cache(void);
1715 extern struct packed_git *add_packed_git(const char *path, size_t path_len, int local);
1716
1717 /*
1718 * Make sure that a pointer access into an mmap'd index file is within bounds,
1719 * and can provide at least 8 bytes of data.
1720 *
1721 * Note that this is only necessary for variable-length segments of the file
1722 * (like the 64-bit extended offset table), as we compare the size to the
1723 * fixed-length parts when we open the file.
1724 */
1725 extern void check_pack_index_ptr(const struct packed_git *p, const void *ptr);
1726
1727 /*
1728 * Return the SHA-1 of the nth object within the specified packfile.
1729 * Open the index if it is not already open. The return value points
1730 * at the SHA-1 within the mmapped index. Return NULL if there is an
1731 * error.
1732 */
1733 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1734 /*
1735 * Like nth_packed_object_sha1, but write the data into the object specified by
1736 * the the first argument. Returns the first argument on success, and NULL on
1737 * error.
1738 */
1739 extern const struct object_id *nth_packed_object_oid(struct object_id *, struct packed_git *, uint32_t n);
1740
1741 /*
1742 * Return the offset of the nth object within the specified packfile.
1743 * The index must already be opened.
1744 */
1745 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1746
1747 /*
1748 * If the object named sha1 is present in the specified packfile,
1749 * return its offset within the packfile; otherwise, return 0.
1750 */
1751 extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1752
1753 extern int is_pack_valid(struct packed_git *);
1754 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1755 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1756 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1757 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1758
1759 /*
1760 * Iterate over the files in the loose-object parts of the object
1761 * directory "path", triggering the following callbacks:
1762 *
1763 * - loose_object is called for each loose object we find.
1764 *
1765 * - loose_cruft is called for any files that do not appear to be
1766 * loose objects. Note that we only look in the loose object
1767 * directories "objects/[0-9a-f]{2}/", so we will not report
1768 * "objects/foobar" as cruft.
1769 *
1770 * - loose_subdir is called for each top-level hashed subdirectory
1771 * of the object directory (e.g., "$OBJDIR/f0"). It is called
1772 * after the objects in the directory are processed.
1773 *
1774 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1775 * will end the iteration.
1776 *
1777 * In the "buf" variant, "path" is a strbuf which will also be used as a
1778 * scratch buffer, but restored to its original contents before
1779 * the function returns.
1780 */
1781 typedef int each_loose_object_fn(const struct object_id *oid,
1782 const char *path,
1783 void *data);
1784 typedef int each_loose_cruft_fn(const char *basename,
1785 const char *path,
1786 void *data);
1787 typedef int each_loose_subdir_fn(int nr,
1788 const char *path,
1789 void *data);
1790 int for_each_loose_file_in_objdir(const char *path,
1791 each_loose_object_fn obj_cb,
1792 each_loose_cruft_fn cruft_cb,
1793 each_loose_subdir_fn subdir_cb,
1794 void *data);
1795 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1796 each_loose_object_fn obj_cb,
1797 each_loose_cruft_fn cruft_cb,
1798 each_loose_subdir_fn subdir_cb,
1799 void *data);
1800
1801 /*
1802 * Iterate over loose and packed objects in both the local
1803 * repository and any alternates repositories (unless the
1804 * LOCAL_ONLY flag is set).
1805 */
1806 #define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1807 typedef int each_packed_object_fn(const struct object_id *oid,
1808 struct packed_git *pack,
1809 uint32_t pos,
1810 void *data);
1811 extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1812 extern int for_each_packed_object(each_packed_object_fn, void *, unsigned flags);
1813
1814 struct object_info {
1815 /* Request */
1816 enum object_type *typep;
1817 unsigned long *sizep;
1818 off_t *disk_sizep;
1819 unsigned char *delta_base_sha1;
1820 struct strbuf *typename;
1821
1822 /* Response */
1823 enum {
1824 OI_CACHED,
1825 OI_LOOSE,
1826 OI_PACKED,
1827 OI_DBCACHED
1828 } whence;
1829 union {
1830 /*
1831 * struct {
1832 * ... Nothing to expose in this case
1833 * } cached;
1834 * struct {
1835 * ... Nothing to expose in this case
1836 * } loose;
1837 */
1838 struct {
1839 struct packed_git *pack;
1840 off_t offset;
1841 unsigned int is_delta;
1842 } packed;
1843 } u;
1844 };
1845
1846 /*
1847 * Initializer for a "struct object_info" that wants no items. You may
1848 * also memset() the memory to all-zeroes.
1849 */
1850 #define OBJECT_INFO_INIT {NULL}
1851
1852 extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1853 extern int packed_object_info(struct packed_git *pack, off_t offset, struct object_info *);
1854
1855 /* Dumb servers support */
1856 extern int update_server_info(int);
1857
1858 /* git_config_parse_key() returns these negated: */
1859 #define CONFIG_INVALID_KEY 1
1860 #define CONFIG_NO_SECTION_OR_NAME 2
1861 /* git_config_set_gently(), git_config_set_multivar_gently() return the above or these: */
1862 #define CONFIG_NO_LOCK -1
1863 #define CONFIG_INVALID_FILE 3
1864 #define CONFIG_NO_WRITE 4
1865 #define CONFIG_NOTHING_SET 5
1866 #define CONFIG_INVALID_PATTERN 6
1867 #define CONFIG_GENERIC_ERROR 7
1868
1869 #define CONFIG_REGEX_NONE ((void *)1)
1870
1871 struct git_config_source {
1872 unsigned int use_stdin:1;
1873 const char *file;
1874 const char *blob;
1875 };
1876
1877 enum config_origin_type {
1878 CONFIG_ORIGIN_BLOB,
1879 CONFIG_ORIGIN_FILE,
1880 CONFIG_ORIGIN_STDIN,
1881 CONFIG_ORIGIN_SUBMODULE_BLOB,
1882 CONFIG_ORIGIN_CMDLINE
1883 };
1884
1885 typedef int (*config_fn_t)(const char *, const char *, void *);
1886 extern int git_default_config(const char *, const char *, void *);
1887 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1888 extern int git_config_from_mem(config_fn_t fn, const enum config_origin_type,
1889 const char *name, const char *buf, size_t len, void *data);
1890 extern int git_config_from_blob_sha1(config_fn_t fn, const char *name,
1891 const unsigned char *sha1, void *data);
1892 extern void git_config_push_parameter(const char *text);
1893 extern int git_config_from_parameters(config_fn_t fn, void *data);
1894 extern void read_early_config(config_fn_t cb, void *data);
1895 extern void git_config(config_fn_t fn, void *);
1896 extern int git_config_with_options(config_fn_t fn, void *,
1897 struct git_config_source *config_source,
1898 int respect_includes);
1899 extern int git_parse_ulong(const char *, unsigned long *);
1900 extern int git_parse_maybe_bool(const char *);
1901 extern int git_config_int(const char *, const char *);
1902 extern int64_t git_config_int64(const char *, const char *);
1903 extern unsigned long git_config_ulong(const char *, const char *);
1904 extern int git_config_bool_or_int(const char *, const char *, int *);
1905 extern int git_config_bool(const char *, const char *);
1906 extern int git_config_maybe_bool(const char *, const char *);
1907 extern int git_config_string(const char **, const char *, const char *);
1908 extern int git_config_pathname(const char **, const char *, const char *);
1909 extern int git_config_set_in_file_gently(const char *, const char *, const char *);
1910 extern void git_config_set_in_file(const char *, const char *, const char *);
1911 extern int git_config_set_gently(const char *, const char *);
1912 extern void git_config_set(const char *, const char *);
1913 extern int git_config_parse_key(const char *, char **, int *);
1914 extern int git_config_key_is_valid(const char *key);
1915 extern int git_config_set_multivar_gently(const char *, const char *, const char *, int);
1916 extern void git_config_set_multivar(const char *, const char *, const char *, int);
1917 extern int git_config_set_multivar_in_file_gently(const char *, const char *, const char *, const char *, int);
1918 extern void git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1919 extern int git_config_rename_section(const char *, const char *);
1920 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1921 extern const char *git_etc_gitconfig(void);
1922 extern int git_env_bool(const char *, int);
1923 extern unsigned long git_env_ulong(const char *, unsigned long);
1924 extern int git_config_system(void);
1925 extern int config_error_nonbool(const char *);
1926 #if defined(__GNUC__)
1927 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1928 #endif
1929 extern const char *get_log_output_encoding(void);
1930 extern const char *get_commit_output_encoding(void);
1931
1932 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1933
1934 enum config_scope {
1935 CONFIG_SCOPE_UNKNOWN = 0,
1936 CONFIG_SCOPE_SYSTEM,
1937 CONFIG_SCOPE_GLOBAL,
1938 CONFIG_SCOPE_REPO,
1939 CONFIG_SCOPE_CMDLINE,
1940 };
1941
1942 extern enum config_scope current_config_scope(void);
1943 extern const char *current_config_origin_type(void);
1944 extern const char *current_config_name(void);
1945
1946 struct config_include_data {
1947 int depth;
1948 config_fn_t fn;
1949 void *data;
1950 };
1951 #define CONFIG_INCLUDE_INIT { 0 }
1952 extern int git_config_include(const char *name, const char *value, void *data);
1953
1954 /*
1955 * Match and parse a config key of the form:
1956 *
1957 * section.(subsection.)?key
1958 *
1959 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1960 * we return -1 if it does not match, 0 otherwise. The subsection and key
1961 * out-parameters are filled by the function (and *subsection is NULL if it is
1962 * missing).
1963 *
1964 * If the subsection pointer-to-pointer passed in is NULL, returns 0 only if
1965 * there is no subsection at all.
1966 */
1967 extern int parse_config_key(const char *var,
1968 const char *section,
1969 const char **subsection, int *subsection_len,
1970 const char **key);
1971
1972 struct config_set_element {
1973 struct hashmap_entry ent;
1974 char *key;
1975 struct string_list value_list;
1976 };
1977
1978 struct configset_list_item {
1979 struct config_set_element *e;
1980 int value_index;
1981 };
1982
1983 /*
1984 * the contents of the list are ordered according to their
1985 * position in the config files and order of parsing the files.
1986 * (i.e. key-value pair at the last position of .git/config will
1987 * be at the last item of the list)
1988 */
1989 struct configset_list {
1990 struct configset_list_item *items;
1991 unsigned int nr, alloc;
1992 };
1993
1994 struct config_set {
1995 struct hashmap config_hash;
1996 int hash_initialized;
1997 struct configset_list list;
1998 };
1999
2000 extern void git_configset_init(struct config_set *cs);
2001 extern int git_configset_add_file(struct config_set *cs, const char *filename);
2002 extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
2003 extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
2004 extern void git_configset_clear(struct config_set *cs);
2005 extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
2006 extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
2007 extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
2008 extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
2009 extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
2010 extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
2011 extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
2012 extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
2013
2014 extern int git_config_get_value(const char *key, const char **value);
2015 extern const struct string_list *git_config_get_value_multi(const char *key);
2016 extern void git_config_clear(void);
2017 extern void git_config_iter(config_fn_t fn, void *data);
2018 extern int git_config_get_string_const(const char *key, const char **dest);
2019 extern int git_config_get_string(const char *key, char **dest);
2020 extern int git_config_get_int(const char *key, int *dest);
2021 extern int git_config_get_ulong(const char *key, unsigned long *dest);
2022 extern int git_config_get_bool(const char *key, int *dest);
2023 extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
2024 extern int git_config_get_maybe_bool(const char *key, int *dest);
2025 extern int git_config_get_pathname(const char *key, const char **dest);
2026 extern int git_config_get_untracked_cache(void);
2027 extern int git_config_get_split_index(void);
2028 extern int git_config_get_max_percent_split_change(void);
2029
2030 /* This dies if the configured or default date is in the future */
2031 extern int git_config_get_expiry(const char *key, const char **output);
2032
2033 /*
2034 * This is a hack for test programs like test-dump-untracked-cache to
2035 * ensure that they do not modify the untracked cache when reading it.
2036 * Do not use it otherwise!
2037 */
2038 extern int ignore_untracked_cache_config;
2039
2040 struct key_value_info {
2041 const char *filename;
2042 int linenr;
2043 enum config_origin_type origin_type;
2044 enum config_scope scope;
2045 };
2046
2047 extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
2048 extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
2049
2050 extern int committer_ident_sufficiently_given(void);
2051 extern int author_ident_sufficiently_given(void);
2052
2053 extern const char *git_commit_encoding;
2054 extern const char *git_log_output_encoding;
2055 extern const char *git_mailmap_file;
2056 extern const char *git_mailmap_blob;
2057
2058 /* IO helper functions */
2059 extern void maybe_flush_or_die(FILE *, const char *);
2060 __attribute__((format (printf, 2, 3)))
2061 extern void fprintf_or_die(FILE *, const char *fmt, ...);
2062
2063 #define COPY_READ_ERROR (-2)
2064 #define COPY_WRITE_ERROR (-3)
2065 extern int copy_fd(int ifd, int ofd);
2066 extern int copy_file(const char *dst, const char *src, int mode);
2067 extern int copy_file_with_time(const char *dst, const char *src, int mode);
2068
2069 extern void write_or_die(int fd, const void *buf, size_t count);
2070 extern void fsync_or_die(int fd, const char *);
2071
2072 extern ssize_t read_in_full(int fd, void *buf, size_t count);
2073 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
2074 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
2075
2076 static inline ssize_t write_str_in_full(int fd, const char *str)
2077 {
2078 return write_in_full(fd, str, strlen(str));
2079 }
2080
2081 /**
2082 * Open (and truncate) the file at path, write the contents of buf to it,
2083 * and close it. Dies if any errors are encountered.
2084 */
2085 extern void write_file_buf(const char *path, const char *buf, size_t len);
2086
2087 /**
2088 * Like write_file_buf(), but format the contents into a buffer first.
2089 * Additionally, write_file() will append a newline if one is not already
2090 * present, making it convenient to write text files:
2091 *
2092 * write_file(path, "counter: %d", ctr);
2093 */
2094 __attribute__((format (printf, 2, 3)))
2095 extern void write_file(const char *path, const char *fmt, ...);
2096
2097 /* pager.c */
2098 extern void setup_pager(void);
2099 extern int pager_in_use(void);
2100 extern int pager_use_color;
2101 extern int term_columns(void);
2102 extern int decimal_width(uintmax_t);
2103 extern int check_pager_config(const char *cmd);
2104 extern void prepare_pager_args(struct child_process *, const char *pager);
2105
2106 extern const char *editor_program;
2107 extern const char *askpass_program;
2108 extern const char *excludes_file;
2109
2110 /* base85 */
2111 int decode_85(char *dst, const char *line, int linelen);
2112 void encode_85(char *buf, const unsigned char *data, int bytes);
2113
2114 /* alloc.c */
2115 extern void *alloc_blob_node(void);
2116 extern void *alloc_tree_node(void);
2117 extern void *alloc_commit_node(void);
2118 extern void *alloc_tag_node(void);
2119 extern void *alloc_object_node(void);
2120 extern void alloc_report(void);
2121 extern unsigned int alloc_commit_index(void);
2122
2123 /* pkt-line.c */
2124 void packet_trace_identity(const char *prog);
2125
2126 /* add */
2127 /*
2128 * return 0 if success, 1 - if addition of a file failed and
2129 * ADD_FILES_IGNORE_ERRORS was specified in flags
2130 */
2131 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
2132
2133 /* diff.c */
2134 extern int diff_auto_refresh_index;
2135
2136 /* match-trees.c */
2137 void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);
2138 void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);
2139
2140 /*
2141 * whitespace rules.
2142 * used by both diff and apply
2143 * last two digits are tab width
2144 */
2145 #define WS_BLANK_AT_EOL 0100
2146 #define WS_SPACE_BEFORE_TAB 0200
2147 #define WS_INDENT_WITH_NON_TAB 0400
2148 #define WS_CR_AT_EOL 01000
2149 #define WS_BLANK_AT_EOF 02000
2150 #define WS_TAB_IN_INDENT 04000
2151 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
2152 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
2153 #define WS_TAB_WIDTH_MASK 077
2154 extern unsigned whitespace_rule_cfg;
2155 extern unsigned whitespace_rule(const char *);
2156 extern unsigned parse_whitespace_rule(const char *);
2157 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
2158 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
2159 extern char *whitespace_error_string(unsigned ws);
2160 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
2161 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
2162 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
2163
2164 /* ls-files */
2165 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
2166
2167 char *alias_lookup(const char *alias);
2168 int split_cmdline(char *cmdline, const char ***argv);
2169 /* Takes a negative value returned by split_cmdline */
2170 const char *split_cmdline_strerror(int cmdline_errno);
2171
2172 /* setup.c */
2173 struct startup_info {
2174 int have_repository;
2175 const char *prefix;
2176 };
2177 extern struct startup_info *startup_info;
2178
2179 /* merge.c */
2180 struct commit_list;
2181 int try_merge_command(const char *strategy, size_t xopts_nr,
2182 const char **xopts, struct commit_list *common,
2183 const char *head_arg, struct commit_list *remotes);
2184 int checkout_fast_forward(const unsigned char *from,
2185 const unsigned char *to,
2186 int overwrite_ignore);
2187
2188
2189 int sane_execvp(const char *file, char *const argv[]);
2190
2191 /*
2192 * A struct to encapsulate the concept of whether a file has changed
2193 * since we last checked it. This uses criteria similar to those used
2194 * for the index.
2195 */
2196 struct stat_validity {
2197 struct stat_data *sd;
2198 };
2199
2200 void stat_validity_clear(struct stat_validity *sv);
2201
2202 /*
2203 * Returns 1 if the path is a regular file (or a symlink to a regular
2204 * file) and matches the saved stat_validity, 0 otherwise. A missing
2205 * or inaccessible file is considered a match if the struct was just
2206 * initialized, or if the previous update found an inaccessible file.
2207 */
2208 int stat_validity_check(struct stat_validity *sv, const char *path);
2209
2210 /*
2211 * Update the stat_validity from a file opened at descriptor fd. If
2212 * the file is missing, inaccessible, or not a regular file, then
2213 * future calls to stat_validity_check will match iff one of those
2214 * conditions continues to be true.
2215 */
2216 void stat_validity_update(struct stat_validity *sv, int fd);
2217
2218 int versioncmp(const char *s1, const char *s2);
2219 void sleep_millisec(int millisec);
2220
2221 /*
2222 * Create a directory and (if share is nonzero) adjust its permissions
2223 * according to the shared_repository setting. Only use this for
2224 * directories under $GIT_DIR. Don't use it for working tree
2225 * directories.
2226 */
2227 void safe_create_dir(const char *dir, int share);
2228
2229 #endif /* CACHE_H */