cache.h

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