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