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