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