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