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