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