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