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