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