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