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