refname_match(): always use the rules in ref_rev_parse_rules
[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 "hash.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 stat_data ce_stat_data;
134 unsigned int ce_mode;
135 unsigned int ce_flags;
136 unsigned int ce_namelen;
137 unsigned char sha1[20];
138 struct cache_entry *next;
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 0xFFFF0000 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_UNHASHED (1 << 21)
163 #define CE_WT_REMOVE (1 << 22) /* remove in work directory */
164 #define CE_CONFLICTED (1 << 23)
165
166 #define CE_UNPACKED (1 << 24)
167 #define CE_NEW_SKIP_WORKTREE (1 << 25)
168
169 /* used to temporarily mark paths matched by pathspecs */
170 #define CE_MATCHED (1 << 26)
171
172 /*
173 * Extended on-disk flags
174 */
175 #define CE_INTENT_TO_ADD (1 << 29)
176 #define CE_SKIP_WORKTREE (1 << 30)
177 /* CE_EXTENDED2 is for future extension */
178 #define CE_EXTENDED2 (1 << 31)
179
180 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
181
182 /*
183 * Safeguard to avoid saving wrong flags:
184 * - CE_EXTENDED2 won't get saved until its semantic is known
185 * - Bits in 0x0000FFFF have been saved in ce_flags already
186 * - Bits in 0x003F0000 are currently in-memory flags
187 */
188 #if CE_EXTENDED_FLAGS & 0x803FFFFF
189 #error "CE_EXTENDED_FLAGS out of range"
190 #endif
191
192 struct pathspec;
193
194 /*
195 * Copy the sha1 and stat state of a cache entry from one to
196 * another. But we never change the name, or the hash state!
197 */
198 #define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
199 static inline void copy_cache_entry(struct cache_entry *dst,
200 const struct cache_entry *src)
201 {
202 unsigned int state = dst->ce_flags & CE_STATE_MASK;
203
204 /* Don't copy hash chain and name */
205 memcpy(dst, src, offsetof(struct cache_entry, next));
206
207 /* Restore the hash state */
208 dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | 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 struct index_state {
272 struct cache_entry **cache;
273 unsigned int version;
274 unsigned int cache_nr, cache_alloc, cache_changed;
275 struct string_list *resolve_undo;
276 struct cache_tree *cache_tree;
277 struct cache_time timestamp;
278 unsigned name_hash_initialized : 1,
279 initialized : 1;
280 struct hash_table name_hash;
281 struct hash_table dir_hash;
282 };
283
284 extern struct index_state the_index;
285
286 /* Name hashing */
287 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
288 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
289 extern void free_name_hash(struct index_state *istate);
290
291
292 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
293 #define active_cache (the_index.cache)
294 #define active_nr (the_index.cache_nr)
295 #define active_alloc (the_index.cache_alloc)
296 #define active_cache_changed (the_index.cache_changed)
297 #define active_cache_tree (the_index.cache_tree)
298
299 #define read_cache() read_index(&the_index)
300 #define read_cache_from(path) read_index_from(&the_index, (path))
301 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
302 #define is_cache_unborn() is_index_unborn(&the_index)
303 #define read_cache_unmerged() read_index_unmerged(&the_index)
304 #define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
305 #define discard_cache() discard_index(&the_index)
306 #define unmerged_cache() unmerged_index(&the_index)
307 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
308 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
309 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
310 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
311 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
312 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
313 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
314 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
315 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
316 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
317 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
318 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
319 #define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
320 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
321 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
322 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
323 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
324 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
325 #endif
326
327 enum object_type {
328 OBJ_BAD = -1,
329 OBJ_NONE = 0,
330 OBJ_COMMIT = 1,
331 OBJ_TREE = 2,
332 OBJ_BLOB = 3,
333 OBJ_TAG = 4,
334 /* 5 for future expansion */
335 OBJ_OFS_DELTA = 6,
336 OBJ_REF_DELTA = 7,
337 OBJ_ANY,
338 OBJ_MAX
339 };
340
341 static inline enum object_type object_type(unsigned int mode)
342 {
343 return S_ISDIR(mode) ? OBJ_TREE :
344 S_ISGITLINK(mode) ? OBJ_COMMIT :
345 OBJ_BLOB;
346 }
347
348 /* Double-check local_repo_env below if you add to this list. */
349 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
350 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
351 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
352 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
353 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
354 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
355 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
356 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
357 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
358 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
359 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
360 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
361 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
362 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
363 #define GITATTRIBUTES_FILE ".gitattributes"
364 #define INFOATTRIBUTES_FILE "info/attributes"
365 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
366 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
367 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
368 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
369 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
370 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
371 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
372 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
373 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
374 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
375
376 /*
377 * This environment variable is expected to contain a boolean indicating
378 * whether we should or should not treat:
379 *
380 * GIT_DIR=foo.git git ...
381 *
382 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
383 * of this, but we use it internally to communicate to sub-processes that we
384 * are in a bare repo. If not set, defaults to true.
385 */
386 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
387
388 /*
389 * Repository-local GIT_* environment variables; these will be cleared
390 * when git spawns a sub-process that runs inside another repository.
391 * The array is NULL-terminated, which makes it easy to pass in the "env"
392 * parameter of a run-command invocation, or to do a simple walk.
393 */
394 extern const char * const local_repo_env[];
395
396 extern int is_bare_repository_cfg;
397 extern int is_bare_repository(void);
398 extern int is_inside_git_dir(void);
399 extern char *git_work_tree_cfg;
400 extern int is_inside_work_tree(void);
401 extern const char *get_git_dir(void);
402 extern int is_git_directory(const char *path);
403 extern char *get_object_directory(void);
404 extern char *get_index_file(void);
405 extern char *get_graft_file(void);
406 extern int set_git_dir(const char *path);
407 extern const char *get_git_namespace(void);
408 extern const char *strip_namespace(const char *namespaced_ref);
409 extern const char *get_git_work_tree(void);
410 extern const char *read_gitfile(const char *path);
411 extern const char *resolve_gitdir(const char *suspect);
412 extern void set_git_work_tree(const char *tree);
413
414 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
415
416 extern const char **get_pathspec(const char *prefix, const char **pathspec);
417 extern void setup_work_tree(void);
418 extern const char *setup_git_directory_gently(int *);
419 extern const char *setup_git_directory(void);
420 extern char *prefix_path(const char *prefix, int len, const char *path);
421 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
422 extern const char *prefix_filename(const char *prefix, int len, const char *path);
423 extern int check_filename(const char *prefix, const char *name);
424 extern void verify_filename(const char *prefix,
425 const char *name,
426 int diagnose_misspelt_rev);
427 extern void verify_non_filename(const char *prefix, const char *name);
428 extern int path_inside_repo(const char *prefix, const char *path);
429
430 #define INIT_DB_QUIET 0x0001
431
432 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
433 extern int init_db(const char *template_dir, unsigned int flags);
434
435 extern void sanitize_stdfds(void);
436
437 #define alloc_nr(x) (((x)+16)*3/2)
438
439 /*
440 * Realloc the buffer pointed at by variable 'x' so that it can hold
441 * at least 'nr' entries; the number of entries currently allocated
442 * is 'alloc', using the standard growing factor alloc_nr() macro.
443 *
444 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
445 */
446 #define ALLOC_GROW(x, nr, alloc) \
447 do { \
448 if ((nr) > alloc) { \
449 if (alloc_nr(alloc) < (nr)) \
450 alloc = (nr); \
451 else \
452 alloc = alloc_nr(alloc); \
453 x = xrealloc((x), alloc * sizeof(*(x))); \
454 } \
455 } while (0)
456
457 /* Initialize and use the cache information */
458 extern int read_index(struct index_state *);
459 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
460 extern int read_index_from(struct index_state *, const char *path);
461 extern int is_index_unborn(struct index_state *);
462 extern int read_index_unmerged(struct index_state *);
463 extern int write_index(struct index_state *, int newfd);
464 extern int discard_index(struct index_state *);
465 extern int unmerged_index(const struct index_state *);
466 extern int verify_path(const char *path);
467 extern struct cache_entry *index_dir_exists(struct index_state *istate, const char *name, int namelen);
468 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
469 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
470 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
471 #define ADD_CACHE_OK_TO_ADD 1 /* Ok to add */
472 #define ADD_CACHE_OK_TO_REPLACE 2 /* Ok to replace file/directory */
473 #define ADD_CACHE_SKIP_DFCHECK 4 /* Ok to skip DF conflict checks */
474 #define ADD_CACHE_JUST_APPEND 8 /* Append only; tree.c::read_tree() */
475 #define ADD_CACHE_NEW_ONLY 16 /* Do not replace existing ones */
476 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
477 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
478 extern int remove_index_entry_at(struct index_state *, int pos);
479 extern void remove_marked_cache_entries(struct index_state *istate);
480 extern int remove_file_from_index(struct index_state *, const char *path);
481 #define ADD_CACHE_VERBOSE 1
482 #define ADD_CACHE_PRETEND 2
483 #define ADD_CACHE_IGNORE_ERRORS 4
484 #define ADD_CACHE_IGNORE_REMOVAL 8
485 #define ADD_CACHE_INTENT 16
486 #define ADD_CACHE_IMPLICIT_DOT 32 /* internal to "git add -u/-A" */
487 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
488 extern int add_file_to_index(struct index_state *, const char *path, int flags);
489 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
490 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
491 extern int index_name_is_other(const struct index_state *, const char *, int);
492 extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
493
494 /* do stat comparison even if CE_VALID is true */
495 #define CE_MATCH_IGNORE_VALID 01
496 /* do not check the contents but report dirty on racily-clean entries */
497 #define CE_MATCH_RACY_IS_DIRTY 02
498 /* do stat comparison even if CE_SKIP_WORKTREE is true */
499 #define CE_MATCH_IGNORE_SKIP_WORKTREE 04
500 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
501 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
502
503 extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
504
505 #define HASH_WRITE_OBJECT 1
506 #define HASH_FORMAT_CHECK 2
507 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
508 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
509
510 /*
511 * Record to sd the data from st that we use to check whether a file
512 * might have changed.
513 */
514 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
515
516 /*
517 * Return 0 if st is consistent with a file not having been changed
518 * since sd was filled. If there are differences, return a
519 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
520 * INODE_CHANGED, and DATA_CHANGED.
521 */
522 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
523
524 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
525
526 #define REFRESH_REALLY 0x0001 /* ignore_valid */
527 #define REFRESH_UNMERGED 0x0002 /* allow unmerged */
528 #define REFRESH_QUIET 0x0004 /* be quiet about it */
529 #define REFRESH_IGNORE_MISSING 0x0008 /* ignore non-existent */
530 #define REFRESH_IGNORE_SUBMODULES 0x0010 /* ignore submodules */
531 #define REFRESH_IN_PORCELAIN 0x0020 /* user friendly output, not "needs update" */
532 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
533
534 struct lock_file {
535 struct lock_file *next;
536 int fd;
537 pid_t owner;
538 char on_list;
539 char filename[PATH_MAX];
540 };
541 #define LOCK_DIE_ON_ERROR 1
542 #define LOCK_NODEREF 2
543 extern int unable_to_lock_error(const char *path, int err);
544 extern NORETURN void unable_to_lock_index_die(const char *path, int err);
545 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
546 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
547 extern int commit_lock_file(struct lock_file *);
548 extern void update_index_if_able(struct index_state *, struct lock_file *);
549
550 extern int hold_locked_index(struct lock_file *, int);
551 extern int commit_locked_index(struct lock_file *);
552 extern void set_alternate_index_output(const char *);
553 extern int close_lock_file(struct lock_file *);
554 extern void rollback_lock_file(struct lock_file *);
555 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
556
557 /* Environment bits from configuration mechanism */
558 extern int trust_executable_bit;
559 extern int trust_ctime;
560 extern int check_stat;
561 extern int quote_path_fully;
562 extern int has_symlinks;
563 extern int minimum_abbrev, default_abbrev;
564 extern int ignore_case;
565 extern int assume_unchanged;
566 extern int prefer_symlink_refs;
567 extern int log_all_ref_updates;
568 extern int warn_ambiguous_refs;
569 extern int warn_on_object_refname_ambiguity;
570 extern int shared_repository;
571 extern const char *apply_default_whitespace;
572 extern const char *apply_default_ignorewhitespace;
573 extern const char *git_attributes_file;
574 extern int zlib_compression_level;
575 extern int core_compression_level;
576 extern int core_compression_seen;
577 extern size_t packed_git_window_size;
578 extern size_t packed_git_limit;
579 extern size_t delta_base_cache_limit;
580 extern unsigned long big_file_threshold;
581 extern unsigned long pack_size_limit_cfg;
582 extern int read_replace_refs;
583 extern int fsync_object_files;
584 extern int core_preload_index;
585 extern int core_apply_sparse_checkout;
586 extern int precomposed_unicode;
587
588 /*
589 * The character that begins a commented line in user-editable file
590 * that is subject to stripspace.
591 */
592 extern char comment_line_char;
593
594 enum branch_track {
595 BRANCH_TRACK_UNSPECIFIED = -1,
596 BRANCH_TRACK_NEVER = 0,
597 BRANCH_TRACK_REMOTE,
598 BRANCH_TRACK_ALWAYS,
599 BRANCH_TRACK_EXPLICIT,
600 BRANCH_TRACK_OVERRIDE
601 };
602
603 enum rebase_setup_type {
604 AUTOREBASE_NEVER = 0,
605 AUTOREBASE_LOCAL,
606 AUTOREBASE_REMOTE,
607 AUTOREBASE_ALWAYS
608 };
609
610 enum push_default_type {
611 PUSH_DEFAULT_NOTHING = 0,
612 PUSH_DEFAULT_MATCHING,
613 PUSH_DEFAULT_SIMPLE,
614 PUSH_DEFAULT_UPSTREAM,
615 PUSH_DEFAULT_CURRENT,
616 PUSH_DEFAULT_UNSPECIFIED
617 };
618
619 extern enum branch_track git_branch_track;
620 extern enum rebase_setup_type autorebase;
621 extern enum push_default_type push_default;
622
623 enum object_creation_mode {
624 OBJECT_CREATION_USES_HARDLINKS = 0,
625 OBJECT_CREATION_USES_RENAMES = 1
626 };
627
628 extern enum object_creation_mode object_creation_mode;
629
630 extern char *notes_ref_name;
631
632 extern int grafts_replace_parents;
633
634 #define GIT_REPO_VERSION 0
635 extern int repository_format_version;
636 extern int check_repository_format(void);
637
638 #define MTIME_CHANGED 0x0001
639 #define CTIME_CHANGED 0x0002
640 #define OWNER_CHANGED 0x0004
641 #define MODE_CHANGED 0x0008
642 #define INODE_CHANGED 0x0010
643 #define DATA_CHANGED 0x0020
644 #define TYPE_CHANGED 0x0040
645
646 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
647 __attribute__((format (printf, 3, 4)));
648 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
649 __attribute__((format (printf, 3, 4)));
650 extern char *git_pathdup(const char *fmt, ...)
651 __attribute__((format (printf, 1, 2)));
652 extern char *mkpathdup(const char *fmt, ...)
653 __attribute__((format (printf, 1, 2)));
654
655 /* Return a statically allocated filename matching the sha1 signature */
656 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
657 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
658 extern char *git_path_submodule(const char *path, const char *fmt, ...)
659 __attribute__((format (printf, 2, 3)));
660
661 extern char *sha1_file_name(const unsigned char *sha1);
662 extern char *sha1_pack_name(const unsigned char *sha1);
663 extern char *sha1_pack_index_name(const unsigned char *sha1);
664 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
665 extern const unsigned char null_sha1[20];
666
667 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
668 {
669 int i;
670
671 for (i = 0; i < 20; i++, sha1++, sha2++) {
672 if (*sha1 != *sha2)
673 return *sha1 - *sha2;
674 }
675
676 return 0;
677 }
678
679 static inline int is_null_sha1(const unsigned char *sha1)
680 {
681 return !hashcmp(sha1, null_sha1);
682 }
683
684 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
685 {
686 memcpy(sha_dst, sha_src, 20);
687 }
688 static inline void hashclr(unsigned char *hash)
689 {
690 memset(hash, 0, 20);
691 }
692
693 #define EMPTY_TREE_SHA1_HEX \
694 "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
695 #define EMPTY_TREE_SHA1_BIN_LITERAL \
696 "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
697 "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
698 #define EMPTY_TREE_SHA1_BIN \
699 ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
700
701 #define EMPTY_BLOB_SHA1_HEX \
702 "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
703 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
704 "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
705 "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
706 #define EMPTY_BLOB_SHA1_BIN \
707 ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
708
709 static inline int is_empty_blob_sha1(const unsigned char *sha1)
710 {
711 return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
712 }
713
714 int git_mkstemp(char *path, size_t n, const char *template);
715
716 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
717
718 /* set default permissions by passing mode arguments to open(2) */
719 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
720 int git_mkstemp_mode(char *pattern, int mode);
721
722 /*
723 * NOTE NOTE NOTE!!
724 *
725 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
726 * not be changed. Old repositories have core.sharedrepository written in
727 * numeric format, and therefore these values are preserved for compatibility
728 * reasons.
729 */
730 enum sharedrepo {
731 PERM_UMASK = 0,
732 OLD_PERM_GROUP = 1,
733 OLD_PERM_EVERYBODY = 2,
734 PERM_GROUP = 0660,
735 PERM_EVERYBODY = 0664
736 };
737 int git_config_perm(const char *var, const char *value);
738 int adjust_shared_perm(const char *path);
739 int safe_create_leading_directories(char *path);
740 int safe_create_leading_directories_const(const char *path);
741 int mkdir_in_gitdir(const char *path);
742 extern void home_config_paths(char **global, char **xdg, char *file);
743 extern char *expand_user_path(const char *path);
744 const char *enter_repo(const char *path, int strict);
745 static inline int is_absolute_path(const char *path)
746 {
747 return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
748 }
749 int is_directory(const char *);
750 const char *real_path(const char *path);
751 const char *real_path_if_valid(const char *path);
752 const char *absolute_path(const char *path);
753 const char *remove_leading_path(const char *in, const char *prefix);
754 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
755 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
756 int normalize_path_copy(char *dst, const char *src);
757 int longest_ancestor_length(const char *path, struct string_list *prefixes);
758 char *strip_path_suffix(const char *path, const char *suffix);
759 int daemon_avoid_alias(const char *path);
760 int offset_1st_component(const char *path);
761
762 /* object replacement */
763 #define READ_SHA1_FILE_REPLACE 1
764 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
765 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
766 {
767 return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
768 }
769 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
770 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
771 {
772 if (!read_replace_refs)
773 return sha1;
774 return do_lookup_replace_object(sha1);
775 }
776
777 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
778 extern int sha1_object_info(const unsigned char *, unsigned long *);
779 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
780 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
781 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
782 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
783 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
784 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
785 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
786
787 /* global flag to enable extra checks when accessing packed objects */
788 extern int do_check_packed_object_crc;
789
790 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
791
792 extern int move_temp_to_file(const char *tmpfile, const char *filename);
793
794 extern int has_sha1_pack(const unsigned char *sha1);
795 extern int has_sha1_file(const unsigned char *sha1);
796 extern int has_loose_object_nonlocal(const unsigned char *sha1);
797
798 extern int has_pack_index(const unsigned char *sha1);
799
800 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
801
802 extern const signed char hexval_table[256];
803 static inline unsigned int hexval(unsigned char c)
804 {
805 return hexval_table[c];
806 }
807
808 /* Convert to/from hex/sha1 representation */
809 #define MINIMUM_ABBREV minimum_abbrev
810 #define DEFAULT_ABBREV default_abbrev
811
812 struct object_context {
813 unsigned char tree[20];
814 char path[PATH_MAX];
815 unsigned mode;
816 };
817
818 #define GET_SHA1_QUIETLY 01
819 #define GET_SHA1_COMMIT 02
820 #define GET_SHA1_COMMITTISH 04
821 #define GET_SHA1_TREE 010
822 #define GET_SHA1_TREEISH 020
823 #define GET_SHA1_BLOB 040
824 #define GET_SHA1_ONLY_TO_DIE 04000
825
826 extern int get_sha1(const char *str, unsigned char *sha1);
827 extern int get_sha1_commit(const char *str, unsigned char *sha1);
828 extern int get_sha1_committish(const char *str, unsigned char *sha1);
829 extern int get_sha1_tree(const char *str, unsigned char *sha1);
830 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
831 extern int get_sha1_blob(const char *str, unsigned char *sha1);
832 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
833 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
834
835 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
836 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
837
838 /*
839 * Try to read a SHA1 in hexadecimal format from the 40 characters
840 * starting at hex. Write the 20-byte result to sha1 in binary form.
841 * Return 0 on success. Reading stops if a NUL is encountered in the
842 * input, so it is safe to pass this function an arbitrary
843 * null-terminated string.
844 */
845 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
846
847 extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
848 extern int read_ref_full(const char *refname, unsigned char *sha1,
849 int reading, int *flags);
850 extern int read_ref(const char *refname, unsigned char *sha1);
851
852 /*
853 * Resolve a reference, recursively following symbolic refererences.
854 *
855 * Store the referred-to object's name in sha1 and return the name of
856 * the non-symbolic reference that ultimately pointed at it. The
857 * return value, if not NULL, is a pointer into either a static buffer
858 * or the input ref.
859 *
860 * If the reference cannot be resolved to an object, the behavior
861 * depends on the "reading" argument:
862 *
863 * - If reading is set, return NULL.
864 *
865 * - If reading is not set, clear sha1 and return the name of the last
866 * reference name in the chain, which will either be a non-symbolic
867 * reference or an undefined reference. If this is a prelude to
868 * "writing" to the ref, the return value is the name of the ref
869 * that will actually be created or changed.
870 *
871 * If flag is non-NULL, set the value that it points to the
872 * combination of REF_ISPACKED (if the reference was found among the
873 * packed references) and REF_ISSYMREF (if the initial reference was a
874 * symbolic reference).
875 *
876 * If ref is not a properly-formatted, normalized reference, return
877 * NULL. If more than MAXDEPTH recursive symbolic lookups are needed,
878 * give up and return NULL.
879 *
880 * errno is sometimes set on errors, but not always.
881 */
882 extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
883 extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
884
885 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
886 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
887 extern int interpret_branch_name(const char *str, int len, struct strbuf *);
888 extern int get_sha1_mb(const char *str, unsigned char *sha1);
889
890 /*
891 * Return true iff abbrev_name is a possible abbreviation for
892 * full_name according to the rules defined by ref_rev_parse_rules in
893 * refs.c.
894 */
895 extern int refname_match(const char *abbrev_name, const char *full_name);
896
897 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
898 extern int validate_headref(const char *ref);
899
900 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
901 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
902 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
903 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
904
905 extern void *read_object_with_reference(const unsigned char *sha1,
906 const char *required_type,
907 unsigned long *size,
908 unsigned char *sha1_ret);
909
910 extern struct object *peel_to_type(const char *name, int namelen,
911 struct object *o, enum object_type);
912
913 enum date_mode {
914 DATE_NORMAL = 0,
915 DATE_RELATIVE,
916 DATE_SHORT,
917 DATE_LOCAL,
918 DATE_ISO8601,
919 DATE_RFC2822,
920 DATE_RAW
921 };
922
923 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
924 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
925 struct strbuf *timebuf);
926 int parse_date(const char *date, char *buf, int bufsize);
927 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
928 int parse_expiry_date(const char *date, unsigned long *timestamp);
929 void datestamp(char *buf, int bufsize);
930 #define approxidate(s) approxidate_careful((s), NULL)
931 unsigned long approxidate_careful(const char *, int *);
932 unsigned long approxidate_relative(const char *date, const struct timeval *now);
933 enum date_mode parse_date_format(const char *format);
934
935 #define IDENT_STRICT 1
936 #define IDENT_NO_DATE 2
937 #define IDENT_NO_NAME 4
938 extern const char *git_author_info(int);
939 extern const char *git_committer_info(int);
940 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
941 extern const char *fmt_name(const char *name, const char *email);
942 extern const char *ident_default_email(void);
943 extern const char *git_editor(void);
944 extern const char *git_pager(int stdout_is_tty);
945 extern int git_ident_config(const char *, const char *, void *);
946
947 struct ident_split {
948 const char *name_begin;
949 const char *name_end;
950 const char *mail_begin;
951 const char *mail_end;
952 const char *date_begin;
953 const char *date_end;
954 const char *tz_begin;
955 const char *tz_end;
956 };
957 /*
958 * Signals an success with 0, but time part of the result may be NULL
959 * if the input lacks timestamp and zone
960 */
961 extern int split_ident_line(struct ident_split *, const char *, int);
962
963 /*
964 * Compare split idents for equality or strict ordering. Note that we
965 * compare only the ident part of the line, ignoring any timestamp.
966 *
967 * Because there are two fields, we must choose one as the primary key; we
968 * currently arbitrarily pick the email.
969 */
970 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
971
972 struct checkout {
973 const char *base_dir;
974 int base_dir_len;
975 unsigned force:1,
976 quiet:1,
977 not_new:1,
978 refresh_cache:1;
979 };
980
981 #define TEMPORARY_FILENAME_LENGTH 25
982 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
983
984 struct cache_def {
985 char path[PATH_MAX + 1];
986 int len;
987 int flags;
988 int track_flags;
989 int prefix_len_stat_func;
990 };
991
992 extern int has_symlink_leading_path(const char *name, int len);
993 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
994 extern int check_leading_path(const char *name, int len);
995 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
996 extern void schedule_dir_for_removal(const char *name, int len);
997 extern void remove_scheduled_dirs(void);
998
999 extern struct alternate_object_database {
1000 struct alternate_object_database *next;
1001 char *name;
1002 char base[FLEX_ARRAY]; /* more */
1003 } *alt_odb_list;
1004 extern void prepare_alt_odb(void);
1005 extern void read_info_alternates(const char * relative_base, int depth);
1006 extern void add_to_alternates_file(const char *reference);
1007 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1008 extern void foreach_alt_odb(alt_odb_fn, void*);
1009
1010 struct pack_window {
1011 struct pack_window *next;
1012 unsigned char *base;
1013 off_t offset;
1014 size_t len;
1015 unsigned int last_used;
1016 unsigned int inuse_cnt;
1017 };
1018
1019 extern struct packed_git {
1020 struct packed_git *next;
1021 struct pack_window *windows;
1022 off_t pack_size;
1023 const void *index_data;
1024 size_t index_size;
1025 uint32_t num_objects;
1026 uint32_t num_bad_objects;
1027 unsigned char *bad_object_sha1;
1028 int index_version;
1029 time_t mtime;
1030 int pack_fd;
1031 unsigned pack_local:1,
1032 pack_keep:1,
1033 do_not_close:1;
1034 unsigned char sha1[20];
1035 /* something like ".git/objects/pack/xxxxx.pack" */
1036 char pack_name[FLEX_ARRAY]; /* more */
1037 } *packed_git;
1038
1039 struct pack_entry {
1040 off_t offset;
1041 unsigned char sha1[20];
1042 struct packed_git *p;
1043 };
1044
1045 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1046
1047 /* A hook for count-objects to report invalid files in pack directory */
1048 extern void (*report_garbage)(const char *desc, const char *path);
1049
1050 extern void prepare_packed_git(void);
1051 extern void reprepare_packed_git(void);
1052 extern void install_packed_git(struct packed_git *pack);
1053
1054 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1055 struct packed_git *packs);
1056
1057 extern void pack_report(void);
1058 extern int open_pack_index(struct packed_git *);
1059 extern void close_pack_index(struct packed_git *);
1060 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1061 extern void close_pack_windows(struct packed_git *);
1062 extern void unuse_pack(struct pack_window **);
1063 extern void free_pack_by_name(const char *);
1064 extern void clear_delta_base_cache(void);
1065 extern struct packed_git *add_packed_git(const char *, int, int);
1066 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
1067 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
1068 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
1069 extern int is_pack_valid(struct packed_git *);
1070 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1071 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1072 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1073 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1074
1075 struct object_info {
1076 /* Request */
1077 enum object_type *typep;
1078 unsigned long *sizep;
1079 unsigned long *disk_sizep;
1080
1081 /* Response */
1082 enum {
1083 OI_CACHED,
1084 OI_LOOSE,
1085 OI_PACKED,
1086 OI_DBCACHED
1087 } whence;
1088 union {
1089 /*
1090 * struct {
1091 * ... Nothing to expose in this case
1092 * } cached;
1093 * struct {
1094 * ... Nothing to expose in this case
1095 * } loose;
1096 */
1097 struct {
1098 struct packed_git *pack;
1099 off_t offset;
1100 unsigned int is_delta;
1101 } packed;
1102 } u;
1103 };
1104 extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
1105
1106 /* Dumb servers support */
1107 extern int update_server_info(int);
1108
1109 /* git_config_parse_key() returns these negated: */
1110 #define CONFIG_INVALID_KEY 1
1111 #define CONFIG_NO_SECTION_OR_NAME 2
1112 /* git_config_set(), git_config_set_multivar() return the above or these: */
1113 #define CONFIG_NO_LOCK -1
1114 #define CONFIG_INVALID_FILE 3
1115 #define CONFIG_NO_WRITE 4
1116 #define CONFIG_NOTHING_SET 5
1117 #define CONFIG_INVALID_PATTERN 6
1118 #define CONFIG_GENERIC_ERROR 7
1119
1120 typedef int (*config_fn_t)(const char *, const char *, void *);
1121 extern int git_default_config(const char *, const char *, void *);
1122 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1123 extern int git_config_from_buf(config_fn_t fn, const char *name,
1124 const char *buf, size_t len, void *data);
1125 extern void git_config_push_parameter(const char *text);
1126 extern int git_config_from_parameters(config_fn_t fn, void *data);
1127 extern int git_config(config_fn_t fn, void *);
1128 extern int git_config_with_options(config_fn_t fn, void *,
1129 const char *filename,
1130 const char *blob_ref,
1131 int respect_includes);
1132 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1133 extern int git_parse_ulong(const char *, unsigned long *);
1134 extern int git_config_int(const char *, const char *);
1135 extern int64_t git_config_int64(const char *, const char *);
1136 extern unsigned long git_config_ulong(const char *, const char *);
1137 extern int git_config_bool_or_int(const char *, const char *, int *);
1138 extern int git_config_bool(const char *, const char *);
1139 extern int git_config_maybe_bool(const char *, const char *);
1140 extern int git_config_string(const char **, const char *, const char *);
1141 extern int git_config_pathname(const char **, const char *, const char *);
1142 extern int git_config_set_in_file(const char *, const char *, const char *);
1143 extern int git_config_set(const char *, const char *);
1144 extern int git_config_parse_key(const char *, char **, int *);
1145 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1146 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1147 extern int git_config_rename_section(const char *, const char *);
1148 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1149 extern const char *git_etc_gitconfig(void);
1150 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1151 extern int git_env_bool(const char *, int);
1152 extern int git_config_system(void);
1153 extern int config_error_nonbool(const char *);
1154 #if defined(__GNUC__) && ! defined(__clang__)
1155 #define config_error_nonbool(s) (config_error_nonbool(s), -1)
1156 #endif
1157 extern const char *get_log_output_encoding(void);
1158 extern const char *get_commit_output_encoding(void);
1159
1160 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1161
1162 struct config_include_data {
1163 int depth;
1164 config_fn_t fn;
1165 void *data;
1166 };
1167 #define CONFIG_INCLUDE_INIT { 0 }
1168 extern int git_config_include(const char *name, const char *value, void *data);
1169
1170 /*
1171 * Match and parse a config key of the form:
1172 *
1173 * section.(subsection.)?key
1174 *
1175 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1176 * we return -1 if it does not match, 0 otherwise. The subsection and key
1177 * out-parameters are filled by the function (and subsection is NULL if it is
1178 * missing).
1179 */
1180 extern int parse_config_key(const char *var,
1181 const char *section,
1182 const char **subsection, int *subsection_len,
1183 const char **key);
1184
1185 extern int committer_ident_sufficiently_given(void);
1186 extern int author_ident_sufficiently_given(void);
1187
1188 extern const char *git_commit_encoding;
1189 extern const char *git_log_output_encoding;
1190 extern const char *git_mailmap_file;
1191 extern const char *git_mailmap_blob;
1192
1193 /* IO helper functions */
1194 extern void maybe_flush_or_die(FILE *, const char *);
1195 extern int copy_fd(int ifd, int ofd);
1196 extern int copy_file(const char *dst, const char *src, int mode);
1197 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1198 extern void write_or_die(int fd, const void *buf, size_t count);
1199 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1200 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1201 extern void fsync_or_die(int fd, const char *);
1202
1203 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1204 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1205 static inline ssize_t write_str_in_full(int fd, const char *str)
1206 {
1207 return write_in_full(fd, str, strlen(str));
1208 }
1209
1210 /* pager.c */
1211 extern void setup_pager(void);
1212 extern const char *pager_program;
1213 extern int pager_in_use(void);
1214 extern int pager_use_color;
1215 extern int term_columns(void);
1216 extern int decimal_width(int);
1217 extern int check_pager_config(const char *cmd);
1218
1219 extern const char *editor_program;
1220 extern const char *askpass_program;
1221 extern const char *excludes_file;
1222
1223 /* base85 */
1224 int decode_85(char *dst, const char *line, int linelen);
1225 void encode_85(char *buf, const unsigned char *data, int bytes);
1226
1227 /* alloc.c */
1228 extern void *alloc_blob_node(void);
1229 extern void *alloc_tree_node(void);
1230 extern void *alloc_commit_node(void);
1231 extern void *alloc_tag_node(void);
1232 extern void *alloc_object_node(void);
1233 extern void alloc_report(void);
1234
1235 /* trace.c */
1236 __attribute__((format (printf, 1, 2)))
1237 extern void trace_printf(const char *format, ...);
1238 __attribute__((format (printf, 2, 3)))
1239 extern void trace_argv_printf(const char **argv, const char *format, ...);
1240 extern void trace_repo_setup(const char *prefix);
1241 extern int trace_want(const char *key);
1242 extern void trace_strbuf(const char *key, const struct strbuf *buf);
1243
1244 void packet_trace_identity(const char *prog);
1245
1246 /* add */
1247 /*
1248 * return 0 if success, 1 - if addition of a file failed and
1249 * ADD_FILES_IGNORE_ERRORS was specified in flags
1250 */
1251 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1252
1253 /* diff.c */
1254 extern int diff_auto_refresh_index;
1255
1256 /* match-trees.c */
1257 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1258 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1259
1260 /*
1261 * whitespace rules.
1262 * used by both diff and apply
1263 * last two digits are tab width
1264 */
1265 #define WS_BLANK_AT_EOL 0100
1266 #define WS_SPACE_BEFORE_TAB 0200
1267 #define WS_INDENT_WITH_NON_TAB 0400
1268 #define WS_CR_AT_EOL 01000
1269 #define WS_BLANK_AT_EOF 02000
1270 #define WS_TAB_IN_INDENT 04000
1271 #define WS_TRAILING_SPACE (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1272 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1273 #define WS_TAB_WIDTH_MASK 077
1274 extern unsigned whitespace_rule_cfg;
1275 extern unsigned whitespace_rule(const char *);
1276 extern unsigned parse_whitespace_rule(const char *);
1277 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1278 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1279 extern char *whitespace_error_string(unsigned ws);
1280 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1281 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1282 #define ws_tab_width(rule) ((rule) & WS_TAB_WIDTH_MASK)
1283
1284 /* ls-files */
1285 int report_path_error(const char *ps_matched, const struct pathspec *pathspec, const char *prefix);
1286 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1287
1288 char *alias_lookup(const char *alias);
1289 int split_cmdline(char *cmdline, const char ***argv);
1290 /* Takes a negative value returned by split_cmdline */
1291 const char *split_cmdline_strerror(int cmdline_errno);
1292
1293 /* git.c */
1294 struct startup_info {
1295 int have_repository;
1296 const char *prefix;
1297 };
1298 extern struct startup_info *startup_info;
1299
1300 /* merge.c */
1301 struct commit_list;
1302 int try_merge_command(const char *strategy, size_t xopts_nr,
1303 const char **xopts, struct commit_list *common,
1304 const char *head_arg, struct commit_list *remotes);
1305 int checkout_fast_forward(const unsigned char *from,
1306 const unsigned char *to,
1307 int overwrite_ignore);
1308
1309
1310 int sane_execvp(const char *file, char *const argv[]);
1311
1312 /*
1313 * A struct to encapsulate the concept of whether a file has changed
1314 * since we last checked it. This uses criteria similar to those used
1315 * for the index.
1316 */
1317 struct stat_validity {
1318 struct stat_data *sd;
1319 };
1320
1321 void stat_validity_clear(struct stat_validity *sv);
1322
1323 /*
1324 * Returns 1 if the path is a regular file (or a symlink to a regular
1325 * file) and matches the saved stat_validity, 0 otherwise. A missing
1326 * or inaccessible file is considered a match if the struct was just
1327 * initialized, or if the previous update found an inaccessible file.
1328 */
1329 int stat_validity_check(struct stat_validity *sv, const char *path);
1330
1331 /*
1332 * Update the stat_validity from a file opened at descriptor fd. If
1333 * the file is missing, inaccessible, or not a regular file, then
1334 * future calls to stat_validity_check will match iff one of those
1335 * conditions continues to be true.
1336 */
1337 void stat_validity_update(struct stat_validity *sv, int fd);
1338
1339 #endif /* CACHE_H */