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