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