cache.hon commit repository: introduce raw object store field (90c6215)
   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 "list.h"
   8#include "advice.h"
   9#include "gettext.h"
  10#include "convert.h"
  11#include "trace.h"
  12#include "string-list.h"
  13#include "pack-revindex.h"
  14#include "hash.h"
  15#include "path.h"
  16#include "sha1-array.h"
  17#include "repository.h"
  18
  19#ifndef platform_SHA_CTX
  20/*
  21 * platform's underlying implementation of SHA-1; could be OpenSSL,
  22 * blk_SHA, Apple CommonCrypto, etc...  Note that including
  23 * SHA1_HEADER may have already defined platform_SHA_CTX for our
  24 * own implementations like block-sha1 and ppc-sha1, so we list
  25 * the default for OpenSSL compatible SHA-1 implementations here.
  26 */
  27#define platform_SHA_CTX        SHA_CTX
  28#define platform_SHA1_Init      SHA1_Init
  29#define platform_SHA1_Update    SHA1_Update
  30#define platform_SHA1_Final     SHA1_Final
  31#endif
  32
  33#define git_SHA_CTX             platform_SHA_CTX
  34#define git_SHA1_Init           platform_SHA1_Init
  35#define git_SHA1_Update         platform_SHA1_Update
  36#define git_SHA1_Final          platform_SHA1_Final
  37
  38#ifdef SHA1_MAX_BLOCK_SIZE
  39#include "compat/sha1-chunked.h"
  40#undef git_SHA1_Update
  41#define git_SHA1_Update         git_SHA1_Update_Chunked
  42#endif
  43
  44#include <zlib.h>
  45typedef struct git_zstream {
  46        z_stream z;
  47        unsigned long avail_in;
  48        unsigned long avail_out;
  49        unsigned long total_in;
  50        unsigned long total_out;
  51        unsigned char *next_in;
  52        unsigned char *next_out;
  53} git_zstream;
  54
  55void git_inflate_init(git_zstream *);
  56void git_inflate_init_gzip_only(git_zstream *);
  57void git_inflate_end(git_zstream *);
  58int git_inflate(git_zstream *, int flush);
  59
  60void git_deflate_init(git_zstream *, int level);
  61void git_deflate_init_gzip(git_zstream *, int level);
  62void git_deflate_init_raw(git_zstream *, int level);
  63void git_deflate_end(git_zstream *);
  64int git_deflate_abort(git_zstream *);
  65int git_deflate_end_gently(git_zstream *);
  66int git_deflate(git_zstream *, int flush);
  67unsigned long git_deflate_bound(git_zstream *, unsigned long);
  68
  69/* The length in bytes and in hex digits of an object name (SHA-1 value). */
  70#define GIT_SHA1_RAWSZ 20
  71#define GIT_SHA1_HEXSZ (2 * GIT_SHA1_RAWSZ)
  72
  73/* The length in byte and in hex digits of the largest possible hash value. */
  74#define GIT_MAX_RAWSZ GIT_SHA1_RAWSZ
  75#define GIT_MAX_HEXSZ GIT_SHA1_HEXSZ
  76
  77struct object_id {
  78        unsigned char hash[GIT_MAX_RAWSZ];
  79};
  80
  81#define the_hash_algo the_repository->hash_algo
  82
  83#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
  84#define DTYPE(de)       ((de)->d_type)
  85#else
  86#undef DT_UNKNOWN
  87#undef DT_DIR
  88#undef DT_REG
  89#undef DT_LNK
  90#define DT_UNKNOWN      0
  91#define DT_DIR          1
  92#define DT_REG          2
  93#define DT_LNK          3
  94#define DTYPE(de)       DT_UNKNOWN
  95#endif
  96
  97/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
  98#define S_IFINVALID     0030000
  99
 100/*
 101 * A "directory link" is a link to another git directory.
 102 *
 103 * The value 0160000 is not normally a valid mode, and
 104 * also just happens to be S_IFDIR + S_IFLNK
 105 */
 106#define S_IFGITLINK     0160000
 107#define S_ISGITLINK(m)  (((m) & S_IFMT) == S_IFGITLINK)
 108
 109/*
 110 * Some mode bits are also used internally for computations.
 111 *
 112 * They *must* not overlap with any valid modes, and they *must* not be emitted
 113 * to outside world - i.e. appear on disk or network. In other words, it's just
 114 * temporary fields, which we internally use, but they have to stay in-house.
 115 *
 116 * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
 117 *   codebase mode is `unsigned int` which is assumed to be at least 32 bits )
 118 */
 119
 120/* used internally in tree-diff */
 121#define S_DIFFTREE_IFXMIN_NEQ   0x80000000
 122
 123
 124/*
 125 * Intensive research over the course of many years has shown that
 126 * port 9418 is totally unused by anything else. Or
 127 *
 128 *      Your search - "port 9418" - did not match any documents.
 129 *
 130 * as www.google.com puts it.
 131 *
 132 * This port has been properly assigned for git use by IANA:
 133 * git (Assigned-9418) [I06-050728-0001].
 134 *
 135 *      git  9418/tcp   git pack transfer service
 136 *      git  9418/udp   git pack transfer service
 137 *
 138 * with Linus Torvalds <torvalds@osdl.org> as the point of
 139 * contact. September 2005.
 140 *
 141 * See http://www.iana.org/assignments/port-numbers
 142 */
 143#define DEFAULT_GIT_PORT 9418
 144
 145/*
 146 * Basic data structures for the directory cache
 147 */
 148
 149#define CACHE_SIGNATURE 0x44495243      /* "DIRC" */
 150struct cache_header {
 151        uint32_t hdr_signature;
 152        uint32_t hdr_version;
 153        uint32_t hdr_entries;
 154};
 155
 156#define INDEX_FORMAT_LB 2
 157#define INDEX_FORMAT_UB 4
 158
 159/*
 160 * The "cache_time" is just the low 32 bits of the
 161 * time. It doesn't matter if it overflows - we only
 162 * check it for equality in the 32 bits we save.
 163 */
 164struct cache_time {
 165        uint32_t sec;
 166        uint32_t nsec;
 167};
 168
 169struct stat_data {
 170        struct cache_time sd_ctime;
 171        struct cache_time sd_mtime;
 172        unsigned int sd_dev;
 173        unsigned int sd_ino;
 174        unsigned int sd_uid;
 175        unsigned int sd_gid;
 176        unsigned int sd_size;
 177};
 178
 179struct cache_entry {
 180        struct hashmap_entry ent;
 181        struct stat_data ce_stat_data;
 182        unsigned int ce_mode;
 183        unsigned int ce_flags;
 184        unsigned int ce_namelen;
 185        unsigned int index;     /* for link extension */
 186        struct object_id oid;
 187        char name[FLEX_ARRAY]; /* more */
 188};
 189
 190#define CE_STAGEMASK (0x3000)
 191#define CE_EXTENDED  (0x4000)
 192#define CE_VALID     (0x8000)
 193#define CE_STAGESHIFT 12
 194
 195/*
 196 * Range 0xFFFF0FFF in ce_flags is divided into
 197 * two parts: in-memory flags and on-disk ones.
 198 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
 199 * if you want to save a new flag, add it in
 200 * CE_EXTENDED_FLAGS
 201 *
 202 * In-memory only flags
 203 */
 204#define CE_UPDATE            (1 << 16)
 205#define CE_REMOVE            (1 << 17)
 206#define CE_UPTODATE          (1 << 18)
 207#define CE_ADDED             (1 << 19)
 208
 209#define CE_HASHED            (1 << 20)
 210#define CE_FSMONITOR_VALID   (1 << 21)
 211#define CE_WT_REMOVE         (1 << 22) /* remove in work directory */
 212#define CE_CONFLICTED        (1 << 23)
 213
 214#define CE_UNPACKED          (1 << 24)
 215#define CE_NEW_SKIP_WORKTREE (1 << 25)
 216
 217/* used to temporarily mark paths matched by pathspecs */
 218#define CE_MATCHED           (1 << 26)
 219
 220#define CE_UPDATE_IN_BASE    (1 << 27)
 221#define CE_STRIP_NAME        (1 << 28)
 222
 223/*
 224 * Extended on-disk flags
 225 */
 226#define CE_INTENT_TO_ADD     (1 << 29)
 227#define CE_SKIP_WORKTREE     (1 << 30)
 228/* CE_EXTENDED2 is for future extension */
 229#define CE_EXTENDED2         (1U << 31)
 230
 231#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
 232
 233/*
 234 * Safeguard to avoid saving wrong flags:
 235 *  - CE_EXTENDED2 won't get saved until its semantic is known
 236 *  - Bits in 0x0000FFFF have been saved in ce_flags already
 237 *  - Bits in 0x003F0000 are currently in-memory flags
 238 */
 239#if CE_EXTENDED_FLAGS & 0x803FFFFF
 240#error "CE_EXTENDED_FLAGS out of range"
 241#endif
 242
 243/* Forward structure decls */
 244struct pathspec;
 245struct child_process;
 246
 247/*
 248 * Copy the sha1 and stat state of a cache entry from one to
 249 * another. But we never change the name, or the hash state!
 250 */
 251static inline void copy_cache_entry(struct cache_entry *dst,
 252                                    const struct cache_entry *src)
 253{
 254        unsigned int state = dst->ce_flags & CE_HASHED;
 255
 256        /* Don't copy hash chain and name */
 257        memcpy(&dst->ce_stat_data, &src->ce_stat_data,
 258                        offsetof(struct cache_entry, name) -
 259                        offsetof(struct cache_entry, ce_stat_data));
 260
 261        /* Restore the hash state */
 262        dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
 263}
 264
 265static inline unsigned create_ce_flags(unsigned stage)
 266{
 267        return (stage << CE_STAGESHIFT);
 268}
 269
 270#define ce_namelen(ce) ((ce)->ce_namelen)
 271#define ce_size(ce) cache_entry_size(ce_namelen(ce))
 272#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
 273#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
 274#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
 275#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
 276#define ce_intent_to_add(ce) ((ce)->ce_flags & CE_INTENT_TO_ADD)
 277
 278#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
 279static inline unsigned int create_ce_mode(unsigned int mode)
 280{
 281        if (S_ISLNK(mode))
 282                return S_IFLNK;
 283        if (S_ISDIR(mode) || S_ISGITLINK(mode))
 284                return S_IFGITLINK;
 285        return S_IFREG | ce_permissions(mode);
 286}
 287static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
 288                                             unsigned int mode)
 289{
 290        extern int trust_executable_bit, has_symlinks;
 291        if (!has_symlinks && S_ISREG(mode) &&
 292            ce && S_ISLNK(ce->ce_mode))
 293                return ce->ce_mode;
 294        if (!trust_executable_bit && S_ISREG(mode)) {
 295                if (ce && S_ISREG(ce->ce_mode))
 296                        return ce->ce_mode;
 297                return create_ce_mode(0666);
 298        }
 299        return create_ce_mode(mode);
 300}
 301static inline int ce_to_dtype(const struct cache_entry *ce)
 302{
 303        unsigned ce_mode = ntohl(ce->ce_mode);
 304        if (S_ISREG(ce_mode))
 305                return DT_REG;
 306        else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
 307                return DT_DIR;
 308        else if (S_ISLNK(ce_mode))
 309                return DT_LNK;
 310        else
 311                return DT_UNKNOWN;
 312}
 313static inline unsigned int canon_mode(unsigned int mode)
 314{
 315        if (S_ISREG(mode))
 316                return S_IFREG | ce_permissions(mode);
 317        if (S_ISLNK(mode))
 318                return S_IFLNK;
 319        if (S_ISDIR(mode))
 320                return S_IFDIR;
 321        return S_IFGITLINK;
 322}
 323
 324#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
 325
 326#define SOMETHING_CHANGED       (1 << 0) /* unclassified changes go here */
 327#define CE_ENTRY_CHANGED        (1 << 1)
 328#define CE_ENTRY_REMOVED        (1 << 2)
 329#define CE_ENTRY_ADDED          (1 << 3)
 330#define RESOLVE_UNDO_CHANGED    (1 << 4)
 331#define CACHE_TREE_CHANGED      (1 << 5)
 332#define SPLIT_INDEX_ORDERED     (1 << 6)
 333#define UNTRACKED_CHANGED       (1 << 7)
 334#define FSMONITOR_CHANGED       (1 << 8)
 335
 336struct split_index;
 337struct untracked_cache;
 338
 339struct index_state {
 340        struct cache_entry **cache;
 341        unsigned int version;
 342        unsigned int cache_nr, cache_alloc, cache_changed;
 343        struct string_list *resolve_undo;
 344        struct cache_tree *cache_tree;
 345        struct split_index *split_index;
 346        struct cache_time timestamp;
 347        unsigned name_hash_initialized : 1,
 348                 initialized : 1,
 349                 drop_cache_tree : 1;
 350        struct hashmap name_hash;
 351        struct hashmap dir_hash;
 352        unsigned char sha1[20];
 353        struct untracked_cache *untracked;
 354        uint64_t fsmonitor_last_update;
 355        struct ewah_bitmap *fsmonitor_dirty;
 356};
 357
 358extern struct index_state the_index;
 359
 360/* Name hashing */
 361extern int test_lazy_init_name_hash(struct index_state *istate, int try_threaded);
 362extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
 363extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
 364extern void free_name_hash(struct index_state *istate);
 365
 366
 367#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
 368#define active_cache (the_index.cache)
 369#define active_nr (the_index.cache_nr)
 370#define active_alloc (the_index.cache_alloc)
 371#define active_cache_changed (the_index.cache_changed)
 372#define active_cache_tree (the_index.cache_tree)
 373
 374#define read_cache() read_index(&the_index)
 375#define read_cache_from(path) read_index_from(&the_index, (path), (get_git_dir()))
 376#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
 377#define is_cache_unborn() is_index_unborn(&the_index)
 378#define read_cache_unmerged() read_index_unmerged(&the_index)
 379#define discard_cache() discard_index(&the_index)
 380#define unmerged_cache() unmerged_index(&the_index)
 381#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
 382#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
 383#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
 384#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
 385#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
 386#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
 387#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
 388#define chmod_cache_entry(ce, flip) chmod_index_entry(&the_index, (ce), (flip))
 389#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
 390#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
 391#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
 392#define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
 393#define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
 394#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
 395#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
 396#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
 397#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
 398#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
 399#endif
 400
 401enum object_type {
 402        OBJ_BAD = -1,
 403        OBJ_NONE = 0,
 404        OBJ_COMMIT = 1,
 405        OBJ_TREE = 2,
 406        OBJ_BLOB = 3,
 407        OBJ_TAG = 4,
 408        /* 5 for future expansion */
 409        OBJ_OFS_DELTA = 6,
 410        OBJ_REF_DELTA = 7,
 411        OBJ_ANY,
 412        OBJ_MAX
 413};
 414
 415static inline enum object_type object_type(unsigned int mode)
 416{
 417        return S_ISDIR(mode) ? OBJ_TREE :
 418                S_ISGITLINK(mode) ? OBJ_COMMIT :
 419                OBJ_BLOB;
 420}
 421
 422/* Double-check local_repo_env below if you add to this list. */
 423#define GIT_DIR_ENVIRONMENT "GIT_DIR"
 424#define GIT_COMMON_DIR_ENVIRONMENT "GIT_COMMON_DIR"
 425#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
 426#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
 427#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
 428#define GIT_SUPER_PREFIX_ENVIRONMENT "GIT_INTERNAL_SUPER_PREFIX"
 429#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
 430#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
 431#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
 432#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
 433#define GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
 434#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
 435#define CONFIG_ENVIRONMENT "GIT_CONFIG"
 436#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
 437#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
 438#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
 439#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
 440#define GIT_REPLACE_REF_BASE_ENVIRONMENT "GIT_REPLACE_REF_BASE"
 441#define GITATTRIBUTES_FILE ".gitattributes"
 442#define INFOATTRIBUTES_FILE "info/attributes"
 443#define ATTRIBUTE_MACRO_PREFIX "[attr]"
 444#define GITMODULES_FILE ".gitmodules"
 445#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
 446#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
 447#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
 448#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
 449#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
 450#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
 451#define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
 452#define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
 453#define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
 454#define GIT_QUARANTINE_ENVIRONMENT "GIT_QUARANTINE_PATH"
 455#define GIT_OPTIONAL_LOCKS_ENVIRONMENT "GIT_OPTIONAL_LOCKS"
 456
 457/*
 458 * Environment variable used in handshaking the wire protocol.
 459 * Contains a colon ':' separated list of keys with optional values
 460 * 'key[=value]'.  Presence of unknown keys and values must be
 461 * ignored.
 462 */
 463#define GIT_PROTOCOL_ENVIRONMENT "GIT_PROTOCOL"
 464/* HTTP header used to handshake the wire protocol */
 465#define GIT_PROTOCOL_HEADER "Git-Protocol"
 466
 467/*
 468 * This environment variable is expected to contain a boolean indicating
 469 * whether we should or should not treat:
 470 *
 471 *   GIT_DIR=foo.git git ...
 472 *
 473 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
 474 * of this, but we use it internally to communicate to sub-processes that we
 475 * are in a bare repo. If not set, defaults to true.
 476 */
 477#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
 478
 479/*
 480 * Repository-local GIT_* environment variables; these will be cleared
 481 * when git spawns a sub-process that runs inside another repository.
 482 * The array is NULL-terminated, which makes it easy to pass in the "env"
 483 * parameter of a run-command invocation, or to do a simple walk.
 484 */
 485extern const char * const local_repo_env[];
 486
 487extern void setup_git_env(const char *git_dir);
 488
 489/*
 490 * Returns true iff we have a configured git repository (either via
 491 * setup_git_directory, or in the environment via $GIT_DIR).
 492 */
 493int have_git_dir(void);
 494
 495extern int is_bare_repository_cfg;
 496extern int is_bare_repository(void);
 497extern int is_inside_git_dir(void);
 498extern char *git_work_tree_cfg;
 499extern int is_inside_work_tree(void);
 500extern const char *get_git_dir(void);
 501extern const char *get_git_common_dir(void);
 502extern char *get_object_directory(void);
 503extern char *get_index_file(void);
 504extern char *get_graft_file(void);
 505extern int set_git_dir(const char *path);
 506extern int get_common_dir_noenv(struct strbuf *sb, const char *gitdir);
 507extern int get_common_dir(struct strbuf *sb, const char *gitdir);
 508extern const char *get_git_namespace(void);
 509extern const char *strip_namespace(const char *namespaced_ref);
 510extern const char *get_super_prefix(void);
 511extern const char *get_git_work_tree(void);
 512
 513/*
 514 * Return true if the given path is a git directory; note that this _just_
 515 * looks at the directory itself. If you want to know whether "foo/.git"
 516 * is a repository, you must feed that path, not just "foo".
 517 */
 518extern int is_git_directory(const char *path);
 519
 520/*
 521 * Return 1 if the given path is the root of a git repository or
 522 * submodule, else 0. Will not return 1 for bare repositories with the
 523 * exception of creating a bare repository in "foo/.git" and calling
 524 * is_git_repository("foo").
 525 *
 526 * If we run into read errors, we err on the side of saying "yes, it is",
 527 * as we usually consider sub-repos precious, and would prefer to err on the
 528 * side of not disrupting or deleting them.
 529 */
 530extern int is_nonbare_repository_dir(struct strbuf *path);
 531
 532#define READ_GITFILE_ERR_STAT_FAILED 1
 533#define READ_GITFILE_ERR_NOT_A_FILE 2
 534#define READ_GITFILE_ERR_OPEN_FAILED 3
 535#define READ_GITFILE_ERR_READ_FAILED 4
 536#define READ_GITFILE_ERR_INVALID_FORMAT 5
 537#define READ_GITFILE_ERR_NO_PATH 6
 538#define READ_GITFILE_ERR_NOT_A_REPO 7
 539#define READ_GITFILE_ERR_TOO_LARGE 8
 540extern void read_gitfile_error_die(int error_code, const char *path, const char *dir);
 541extern const char *read_gitfile_gently(const char *path, int *return_error_code);
 542#define read_gitfile(path) read_gitfile_gently((path), NULL)
 543extern const char *resolve_gitdir_gently(const char *suspect, int *return_error_code);
 544#define resolve_gitdir(path) resolve_gitdir_gently((path), NULL)
 545
 546extern void set_git_work_tree(const char *tree);
 547
 548#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
 549
 550extern void setup_work_tree(void);
 551/*
 552 * Find the commondir and gitdir of the repository that contains the current
 553 * working directory, without changing the working directory or other global
 554 * state. The result is appended to commondir and gitdir.  If the discovered
 555 * gitdir does not correspond to a worktree, then 'commondir' and 'gitdir' will
 556 * both have the same result appended to the buffer.  The return value is
 557 * either 0 upon success and non-zero if no repository was found.
 558 */
 559extern int discover_git_directory(struct strbuf *commondir,
 560                                  struct strbuf *gitdir);
 561extern const char *setup_git_directory_gently(int *);
 562extern const char *setup_git_directory(void);
 563extern char *prefix_path(const char *prefix, int len, const char *path);
 564extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
 565
 566/*
 567 * Concatenate "prefix" (if len is non-zero) and "path", with no
 568 * connecting characters (so "prefix" should end with a "/").
 569 * Unlike prefix_path, this should be used if the named file does
 570 * not have to interact with index entry; i.e. name of a random file
 571 * on the filesystem.
 572 *
 573 * The return value is always a newly allocated string (even if the
 574 * prefix was empty).
 575 */
 576extern char *prefix_filename(const char *prefix, const char *path);
 577
 578extern int check_filename(const char *prefix, const char *name);
 579extern void verify_filename(const char *prefix,
 580                            const char *name,
 581                            int diagnose_misspelt_rev);
 582extern void verify_non_filename(const char *prefix, const char *name);
 583extern int path_inside_repo(const char *prefix, const char *path);
 584
 585#define INIT_DB_QUIET 0x0001
 586#define INIT_DB_EXIST_OK 0x0002
 587
 588extern int init_db(const char *git_dir, const char *real_git_dir,
 589                   const char *template_dir, unsigned int flags);
 590
 591extern void sanitize_stdfds(void);
 592extern int daemonize(void);
 593
 594#define alloc_nr(x) (((x)+16)*3/2)
 595
 596/*
 597 * Realloc the buffer pointed at by variable 'x' so that it can hold
 598 * at least 'nr' entries; the number of entries currently allocated
 599 * is 'alloc', using the standard growing factor alloc_nr() macro.
 600 *
 601 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
 602 */
 603#define ALLOC_GROW(x, nr, alloc) \
 604        do { \
 605                if ((nr) > alloc) { \
 606                        if (alloc_nr(alloc) < (nr)) \
 607                                alloc = (nr); \
 608                        else \
 609                                alloc = alloc_nr(alloc); \
 610                        REALLOC_ARRAY(x, alloc); \
 611                } \
 612        } while (0)
 613
 614/* Initialize and use the cache information */
 615struct lock_file;
 616extern int read_index(struct index_state *);
 617extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
 618extern int do_read_index(struct index_state *istate, const char *path,
 619                         int must_exist); /* for testting only! */
 620extern int read_index_from(struct index_state *, const char *path,
 621                           const char *gitdir);
 622extern int is_index_unborn(struct index_state *);
 623extern int read_index_unmerged(struct index_state *);
 624
 625/* For use with `write_locked_index()`. */
 626#define COMMIT_LOCK             (1 << 0)
 627
 628/*
 629 * Write the index while holding an already-taken lock. Close the lock,
 630 * and if `COMMIT_LOCK` is given, commit it.
 631 *
 632 * Unless a split index is in use, write the index into the lockfile.
 633 *
 634 * With a split index, write the shared index to a temporary file,
 635 * adjust its permissions and rename it into place, then write the
 636 * split index to the lockfile. If the temporary file for the shared
 637 * index cannot be created, fall back to the behavior described in
 638 * the previous paragraph.
 639 *
 640 * With `COMMIT_LOCK`, the lock is always committed or rolled back.
 641 * Without it, the lock is closed, but neither committed nor rolled
 642 * back.
 643 */
 644extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
 645
 646extern int discard_index(struct index_state *);
 647extern void move_index_extensions(struct index_state *dst, struct index_state *src);
 648extern int unmerged_index(const struct index_state *);
 649
 650/**
 651 * Returns 1 if the index differs from HEAD, 0 otherwise. When on an unborn
 652 * branch, returns 1 if there are entries in the index, 0 otherwise. If an
 653 * strbuf is provided, the space-separated list of files that differ will be
 654 * appended to it.
 655 */
 656extern int index_has_changes(struct strbuf *sb);
 657
 658extern int verify_path(const char *path);
 659extern int strcmp_offset(const char *s1, const char *s2, size_t *first_change);
 660extern int index_dir_exists(struct index_state *istate, const char *name, int namelen);
 661extern void adjust_dirname_case(struct index_state *istate, char *name);
 662extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
 663
 664/*
 665 * Searches for an entry defined by name and namelen in the given index.
 666 * If the return value is positive (including 0) it is the position of an
 667 * exact match. If the return value is negative, the negated value minus 1
 668 * is the position where the entry would be inserted.
 669 * Example: The current index consists of these files and its stages:
 670 *
 671 *   b#0, d#0, f#1, f#3
 672 *
 673 * index_name_pos(&index, "a", 1) -> -1
 674 * index_name_pos(&index, "b", 1) ->  0
 675 * index_name_pos(&index, "c", 1) -> -2
 676 * index_name_pos(&index, "d", 1) ->  1
 677 * index_name_pos(&index, "e", 1) -> -3
 678 * index_name_pos(&index, "f", 1) -> -3
 679 * index_name_pos(&index, "g", 1) -> -5
 680 */
 681extern int index_name_pos(const struct index_state *, const char *name, int namelen);
 682
 683#define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
 684#define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
 685#define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
 686#define ADD_CACHE_JUST_APPEND 8         /* Append only; tree.c::read_tree() */
 687#define ADD_CACHE_NEW_ONLY 16           /* Do not replace existing ones */
 688#define ADD_CACHE_KEEP_CACHE_TREE 32    /* Do not invalidate cache-tree */
 689extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
 690extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
 691
 692/* Remove entry, return true if there are more entries to go. */
 693extern int remove_index_entry_at(struct index_state *, int pos);
 694
 695extern void remove_marked_cache_entries(struct index_state *istate);
 696extern int remove_file_from_index(struct index_state *, const char *path);
 697#define ADD_CACHE_VERBOSE 1
 698#define ADD_CACHE_PRETEND 2
 699#define ADD_CACHE_IGNORE_ERRORS 4
 700#define ADD_CACHE_IGNORE_REMOVAL 8
 701#define ADD_CACHE_INTENT 16
 702/*
 703 * These two are used to add the contents of the file at path
 704 * to the index, marking the working tree up-to-date by storing
 705 * the cached stat info in the resulting cache entry.  A caller
 706 * that has already run lstat(2) on the path can call
 707 * add_to_index(), and all others can call add_file_to_index();
 708 * the latter will do necessary lstat(2) internally before
 709 * calling the former.
 710 */
 711extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
 712extern int add_file_to_index(struct index_state *, const char *path, int flags);
 713
 714extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
 715extern int chmod_index_entry(struct index_state *, struct cache_entry *ce, char flip);
 716extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
 717extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
 718extern int index_name_is_other(const struct index_state *, const char *, int);
 719extern void *read_blob_data_from_index(const struct index_state *, const char *, unsigned long *);
 720
 721/* do stat comparison even if CE_VALID is true */
 722#define CE_MATCH_IGNORE_VALID           01
 723/* do not check the contents but report dirty on racily-clean entries */
 724#define CE_MATCH_RACY_IS_DIRTY          02
 725/* do stat comparison even if CE_SKIP_WORKTREE is true */
 726#define CE_MATCH_IGNORE_SKIP_WORKTREE   04
 727/* ignore non-existent files during stat update  */
 728#define CE_MATCH_IGNORE_MISSING         0x08
 729/* enable stat refresh */
 730#define CE_MATCH_REFRESH                0x10
 731/* don't refresh_fsmonitor state or do stat comparison even if CE_FSMONITOR_VALID is true */
 732#define CE_MATCH_IGNORE_FSMONITOR 0X20
 733extern int ie_match_stat(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
 734extern int ie_modified(struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
 735
 736#define HASH_WRITE_OBJECT 1
 737#define HASH_FORMAT_CHECK 2
 738#define HASH_RENORMALIZE  4
 739extern int index_fd(struct object_id *oid, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
 740extern int index_path(struct object_id *oid, const char *path, struct stat *st, unsigned flags);
 741
 742/*
 743 * Record to sd the data from st that we use to check whether a file
 744 * might have changed.
 745 */
 746extern void fill_stat_data(struct stat_data *sd, struct stat *st);
 747
 748/*
 749 * Return 0 if st is consistent with a file not having been changed
 750 * since sd was filled.  If there are differences, return a
 751 * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
 752 * INODE_CHANGED, and DATA_CHANGED.
 753 */
 754extern int match_stat_data(const struct stat_data *sd, struct stat *st);
 755extern int match_stat_data_racy(const struct index_state *istate,
 756                                const struct stat_data *sd, struct stat *st);
 757
 758extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
 759
 760#define REFRESH_REALLY          0x0001  /* ignore_valid */
 761#define REFRESH_UNMERGED        0x0002  /* allow unmerged */
 762#define REFRESH_QUIET           0x0004  /* be quiet about it */
 763#define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
 764#define REFRESH_IGNORE_SUBMODULES       0x0010  /* ignore submodules */
 765#define REFRESH_IN_PORCELAIN    0x0020  /* user friendly output, not "needs update" */
 766extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
 767extern struct cache_entry *refresh_cache_entry(struct cache_entry *, unsigned int);
 768
 769/*
 770 * Opportunistically update the index but do not complain if we can't.
 771 * The lockfile is always committed or rolled back.
 772 */
 773extern void update_index_if_able(struct index_state *, struct lock_file *);
 774
 775extern int hold_locked_index(struct lock_file *, int);
 776extern void set_alternate_index_output(const char *);
 777
 778extern int verify_index_checksum;
 779extern int verify_ce_order;
 780
 781/* Environment bits from configuration mechanism */
 782extern int trust_executable_bit;
 783extern int trust_ctime;
 784extern int check_stat;
 785extern int quote_path_fully;
 786extern int has_symlinks;
 787extern int minimum_abbrev, default_abbrev;
 788extern int ignore_case;
 789extern int assume_unchanged;
 790extern int prefer_symlink_refs;
 791extern int warn_ambiguous_refs;
 792extern int warn_on_object_refname_ambiguity;
 793extern const char *apply_default_whitespace;
 794extern const char *apply_default_ignorewhitespace;
 795extern const char *git_attributes_file;
 796extern const char *git_hooks_path;
 797extern int zlib_compression_level;
 798extern int core_compression_level;
 799extern int pack_compression_level;
 800extern size_t packed_git_window_size;
 801extern size_t packed_git_limit;
 802extern size_t delta_base_cache_limit;
 803extern unsigned long big_file_threshold;
 804extern unsigned long pack_size_limit_cfg;
 805
 806/*
 807 * Accessors for the core.sharedrepository config which lazy-load the value
 808 * from the config (if not already set). The "reset" function can be
 809 * used to unset "set" or cached value, meaning that the value will be loaded
 810 * fresh from the config file on the next call to get_shared_repository().
 811 */
 812void set_shared_repository(int value);
 813int get_shared_repository(void);
 814void reset_shared_repository(void);
 815
 816/*
 817 * Do replace refs need to be checked this run?  This variable is
 818 * initialized to true unless --no-replace-object is used or
 819 * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
 820 * commands that do not want replace references to be active.  As an
 821 * optimization it is also set to false if replace references have
 822 * been sought but there were none.
 823 */
 824extern int check_replace_refs;
 825extern char *git_replace_ref_base;
 826
 827extern int fsync_object_files;
 828extern int core_preload_index;
 829extern int core_apply_sparse_checkout;
 830extern int precomposed_unicode;
 831extern int protect_hfs;
 832extern int protect_ntfs;
 833extern const char *core_fsmonitor;
 834
 835/*
 836 * Include broken refs in all ref iterations, which will
 837 * generally choke dangerous operations rather than letting
 838 * them silently proceed without taking the broken ref into
 839 * account.
 840 */
 841extern int ref_paranoia;
 842
 843/*
 844 * Returns the boolean value of $GIT_OPTIONAL_LOCKS (or the default value).
 845 */
 846int use_optional_locks(void);
 847
 848/*
 849 * The character that begins a commented line in user-editable file
 850 * that is subject to stripspace.
 851 */
 852extern char comment_line_char;
 853extern int auto_comment_line_char;
 854
 855/* Windows only */
 856enum hide_dotfiles_type {
 857        HIDE_DOTFILES_FALSE = 0,
 858        HIDE_DOTFILES_TRUE,
 859        HIDE_DOTFILES_DOTGITONLY
 860};
 861extern enum hide_dotfiles_type hide_dotfiles;
 862
 863enum log_refs_config {
 864        LOG_REFS_UNSET = -1,
 865        LOG_REFS_NONE = 0,
 866        LOG_REFS_NORMAL,
 867        LOG_REFS_ALWAYS
 868};
 869extern enum log_refs_config log_all_ref_updates;
 870
 871enum branch_track {
 872        BRANCH_TRACK_UNSPECIFIED = -1,
 873        BRANCH_TRACK_NEVER = 0,
 874        BRANCH_TRACK_REMOTE,
 875        BRANCH_TRACK_ALWAYS,
 876        BRANCH_TRACK_EXPLICIT,
 877        BRANCH_TRACK_OVERRIDE
 878};
 879
 880enum rebase_setup_type {
 881        AUTOREBASE_NEVER = 0,
 882        AUTOREBASE_LOCAL,
 883        AUTOREBASE_REMOTE,
 884        AUTOREBASE_ALWAYS
 885};
 886
 887enum push_default_type {
 888        PUSH_DEFAULT_NOTHING = 0,
 889        PUSH_DEFAULT_MATCHING,
 890        PUSH_DEFAULT_SIMPLE,
 891        PUSH_DEFAULT_UPSTREAM,
 892        PUSH_DEFAULT_CURRENT,
 893        PUSH_DEFAULT_UNSPECIFIED
 894};
 895
 896extern enum branch_track git_branch_track;
 897extern enum rebase_setup_type autorebase;
 898extern enum push_default_type push_default;
 899
 900enum object_creation_mode {
 901        OBJECT_CREATION_USES_HARDLINKS = 0,
 902        OBJECT_CREATION_USES_RENAMES = 1
 903};
 904
 905extern enum object_creation_mode object_creation_mode;
 906
 907extern char *notes_ref_name;
 908
 909extern int grafts_replace_parents;
 910
 911/*
 912 * GIT_REPO_VERSION is the version we write by default. The
 913 * _READ variant is the highest number we know how to
 914 * handle.
 915 */
 916#define GIT_REPO_VERSION 0
 917#define GIT_REPO_VERSION_READ 1
 918extern int repository_format_precious_objects;
 919extern char *repository_format_partial_clone;
 920extern const char *core_partial_clone_filter_default;
 921
 922struct repository_format {
 923        int version;
 924        int precious_objects;
 925        char *partial_clone; /* value of extensions.partialclone */
 926        int is_bare;
 927        int hash_algo;
 928        char *work_tree;
 929        struct string_list unknown_extensions;
 930};
 931
 932/*
 933 * Read the repository format characteristics from the config file "path" into
 934 * "format" struct. Returns the numeric version. On error, -1 is returned,
 935 * format->version is set to -1, and all other fields in the struct are
 936 * undefined.
 937 */
 938int read_repository_format(struct repository_format *format, const char *path);
 939
 940/*
 941 * Verify that the repository described by repository_format is something we
 942 * can read. If it is, return 0. Otherwise, return -1, and "err" will describe
 943 * any errors encountered.
 944 */
 945int verify_repository_format(const struct repository_format *format,
 946                             struct strbuf *err);
 947
 948/*
 949 * Check the repository format version in the path found in get_git_dir(),
 950 * and die if it is a version we don't understand. Generally one would
 951 * set_git_dir() before calling this, and use it only for "are we in a valid
 952 * repo?".
 953 */
 954extern void check_repository_format(void);
 955
 956#define MTIME_CHANGED   0x0001
 957#define CTIME_CHANGED   0x0002
 958#define OWNER_CHANGED   0x0004
 959#define MODE_CHANGED    0x0008
 960#define INODE_CHANGED   0x0010
 961#define DATA_CHANGED    0x0020
 962#define TYPE_CHANGED    0x0040
 963
 964/*
 965 * Put in `buf` the name of the file in the local object database that
 966 * would be used to store a loose object with the specified sha1.
 967 */
 968extern void sha1_file_name(struct strbuf *buf, const unsigned char *sha1);
 969
 970/*
 971 * Return an abbreviated sha1 unique within this repository's object database.
 972 * The result will be at least `len` characters long, and will be NUL
 973 * terminated.
 974 *
 975 * The non-`_r` version returns a static buffer which remains valid until 4
 976 * more calls to find_unique_abbrev are made.
 977 *
 978 * The `_r` variant writes to a buffer supplied by the caller, which must be at
 979 * least `GIT_SHA1_HEXSZ + 1` bytes. The return value is the number of bytes
 980 * written (excluding the NUL terminator).
 981 *
 982 * Note that while this version avoids the static buffer, it is not fully
 983 * reentrant, as it calls into other non-reentrant git code.
 984 */
 985extern const char *find_unique_abbrev(const unsigned char *sha1, int len);
 986extern int find_unique_abbrev_r(char *hex, const unsigned char *sha1, int len);
 987
 988extern const unsigned char null_sha1[GIT_MAX_RAWSZ];
 989extern const struct object_id null_oid;
 990
 991static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
 992{
 993        return memcmp(sha1, sha2, GIT_SHA1_RAWSZ);
 994}
 995
 996static inline int oidcmp(const struct object_id *oid1, const struct object_id *oid2)
 997{
 998        return hashcmp(oid1->hash, oid2->hash);
 999}
1000
1001static inline int is_null_sha1(const unsigned char *sha1)
1002{
1003        return !hashcmp(sha1, null_sha1);
1004}
1005
1006static inline int is_null_oid(const struct object_id *oid)
1007{
1008        return !hashcmp(oid->hash, null_sha1);
1009}
1010
1011static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
1012{
1013        memcpy(sha_dst, sha_src, GIT_SHA1_RAWSZ);
1014}
1015
1016static inline void oidcpy(struct object_id *dst, const struct object_id *src)
1017{
1018        hashcpy(dst->hash, src->hash);
1019}
1020
1021static inline struct object_id *oiddup(const struct object_id *src)
1022{
1023        struct object_id *dst = xmalloc(sizeof(struct object_id));
1024        oidcpy(dst, src);
1025        return dst;
1026}
1027
1028static inline void hashclr(unsigned char *hash)
1029{
1030        memset(hash, 0, GIT_SHA1_RAWSZ);
1031}
1032
1033static inline void oidclr(struct object_id *oid)
1034{
1035        hashclr(oid->hash);
1036}
1037
1038
1039#define EMPTY_TREE_SHA1_HEX \
1040        "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
1041#define EMPTY_TREE_SHA1_BIN_LITERAL \
1042         "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
1043         "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
1044extern const struct object_id empty_tree_oid;
1045#define EMPTY_TREE_SHA1_BIN (empty_tree_oid.hash)
1046
1047#define EMPTY_BLOB_SHA1_HEX \
1048        "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
1049#define EMPTY_BLOB_SHA1_BIN_LITERAL \
1050        "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
1051        "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
1052extern const struct object_id empty_blob_oid;
1053#define EMPTY_BLOB_SHA1_BIN (empty_blob_oid.hash)
1054
1055
1056static inline int is_empty_blob_sha1(const unsigned char *sha1)
1057{
1058        return !hashcmp(sha1, the_hash_algo->empty_blob->hash);
1059}
1060
1061static inline int is_empty_blob_oid(const struct object_id *oid)
1062{
1063        return !oidcmp(oid, the_hash_algo->empty_blob);
1064}
1065
1066static inline int is_empty_tree_sha1(const unsigned char *sha1)
1067{
1068        return !hashcmp(sha1, the_hash_algo->empty_tree->hash);
1069}
1070
1071static inline int is_empty_tree_oid(const struct object_id *oid)
1072{
1073        return !oidcmp(oid, the_hash_algo->empty_tree);
1074}
1075
1076/* set default permissions by passing mode arguments to open(2) */
1077int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
1078int git_mkstemp_mode(char *pattern, int mode);
1079
1080/*
1081 * NOTE NOTE NOTE!!
1082 *
1083 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
1084 * not be changed. Old repositories have core.sharedrepository written in
1085 * numeric format, and therefore these values are preserved for compatibility
1086 * reasons.
1087 */
1088enum sharedrepo {
1089        PERM_UMASK          = 0,
1090        OLD_PERM_GROUP      = 1,
1091        OLD_PERM_EVERYBODY  = 2,
1092        PERM_GROUP          = 0660,
1093        PERM_EVERYBODY      = 0664
1094};
1095int git_config_perm(const char *var, const char *value);
1096int adjust_shared_perm(const char *path);
1097
1098/*
1099 * Create the directory containing the named path, using care to be
1100 * somewhat safe against races. Return one of the scld_error values to
1101 * indicate success/failure. On error, set errno to describe the
1102 * problem.
1103 *
1104 * SCLD_VANISHED indicates that one of the ancestor directories of the
1105 * path existed at one point during the function call and then
1106 * suddenly vanished, probably because another process pruned the
1107 * directory while we were working.  To be robust against this kind of
1108 * race, callers might want to try invoking the function again when it
1109 * returns SCLD_VANISHED.
1110 *
1111 * safe_create_leading_directories() temporarily changes path while it
1112 * is working but restores it before returning.
1113 * safe_create_leading_directories_const() doesn't modify path, even
1114 * temporarily.
1115 */
1116enum scld_error {
1117        SCLD_OK = 0,
1118        SCLD_FAILED = -1,
1119        SCLD_PERMS = -2,
1120        SCLD_EXISTS = -3,
1121        SCLD_VANISHED = -4
1122};
1123enum scld_error safe_create_leading_directories(char *path);
1124enum scld_error safe_create_leading_directories_const(const char *path);
1125
1126/*
1127 * Callback function for raceproof_create_file(). This function is
1128 * expected to do something that makes dirname(path) permanent despite
1129 * the fact that other processes might be cleaning up empty
1130 * directories at the same time. Usually it will create a file named
1131 * path, but alternatively it could create another file in that
1132 * directory, or even chdir() into that directory. The function should
1133 * return 0 if the action was completed successfully. On error, it
1134 * should return a nonzero result and set errno.
1135 * raceproof_create_file() treats two errno values specially:
1136 *
1137 * - ENOENT -- dirname(path) does not exist. In this case,
1138 *             raceproof_create_file() tries creating dirname(path)
1139 *             (and any parent directories, if necessary) and calls
1140 *             the function again.
1141 *
1142 * - EISDIR -- the file already exists and is a directory. In this
1143 *             case, raceproof_create_file() removes the directory if
1144 *             it is empty (and recursively any empty directories that
1145 *             it contains) and calls the function again.
1146 *
1147 * Any other errno causes raceproof_create_file() to fail with the
1148 * callback's return value and errno.
1149 *
1150 * Obviously, this function should be OK with being called again if it
1151 * fails with ENOENT or EISDIR. In other scenarios it will not be
1152 * called again.
1153 */
1154typedef int create_file_fn(const char *path, void *cb);
1155
1156/*
1157 * Create a file in dirname(path) by calling fn, creating leading
1158 * directories if necessary. Retry a few times in case we are racing
1159 * with another process that is trying to clean up the directory that
1160 * contains path. See the documentation for create_file_fn for more
1161 * details.
1162 *
1163 * Return the value and set the errno that resulted from the most
1164 * recent call of fn. fn is always called at least once, and will be
1165 * called more than once if it returns ENOENT or EISDIR.
1166 */
1167int raceproof_create_file(const char *path, create_file_fn fn, void *cb);
1168
1169int mkdir_in_gitdir(const char *path);
1170extern char *expand_user_path(const char *path, int real_home);
1171const char *enter_repo(const char *path, int strict);
1172static inline int is_absolute_path(const char *path)
1173{
1174        return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
1175}
1176int is_directory(const char *);
1177char *strbuf_realpath(struct strbuf *resolved, const char *path,
1178                      int die_on_error);
1179const char *real_path(const char *path);
1180const char *real_path_if_valid(const char *path);
1181char *real_pathdup(const char *path, int die_on_error);
1182const char *absolute_path(const char *path);
1183char *absolute_pathdup(const char *path);
1184const char *remove_leading_path(const char *in, const char *prefix);
1185const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
1186int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
1187int normalize_path_copy(char *dst, const char *src);
1188int longest_ancestor_length(const char *path, struct string_list *prefixes);
1189char *strip_path_suffix(const char *path, const char *suffix);
1190int daemon_avoid_alias(const char *path);
1191extern int is_ntfs_dotgit(const char *name);
1192
1193/*
1194 * Returns true iff "str" could be confused as a command-line option when
1195 * passed to a sub-program like "ssh". Note that this has nothing to do with
1196 * shell-quoting, which should be handled separately; we're assuming here that
1197 * the string makes it verbatim to the sub-program.
1198 */
1199int looks_like_command_line_option(const char *str);
1200
1201/**
1202 * Return a newly allocated string with the evaluation of
1203 * "$XDG_CONFIG_HOME/git/$filename" if $XDG_CONFIG_HOME is non-empty, otherwise
1204 * "$HOME/.config/git/$filename". Return NULL upon error.
1205 */
1206extern char *xdg_config_home(const char *filename);
1207
1208/**
1209 * Return a newly allocated string with the evaluation of
1210 * "$XDG_CACHE_HOME/git/$filename" if $XDG_CACHE_HOME is non-empty, otherwise
1211 * "$HOME/.cache/git/$filename". Return NULL upon error.
1212 */
1213extern char *xdg_cache_home(const char *filename);
1214
1215extern void *read_sha1_file_extended(const unsigned char *sha1,
1216                                     enum object_type *type,
1217                                     unsigned long *size, int lookup_replace);
1218static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
1219{
1220        return read_sha1_file_extended(sha1, type, size, 1);
1221}
1222
1223/*
1224 * This internal function is only declared here for the benefit of
1225 * lookup_replace_object().  Please do not call it directly.
1226 */
1227extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
1228
1229/*
1230 * If object sha1 should be replaced, return the replacement object's
1231 * name (replaced recursively, if necessary).  The return value is
1232 * either sha1 or a pointer to a permanently-allocated value.  When
1233 * object replacement is suppressed, always return sha1.
1234 */
1235static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
1236{
1237        if (!check_replace_refs)
1238                return sha1;
1239        return do_lookup_replace_object(sha1);
1240}
1241
1242/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
1243extern int sha1_object_info(const unsigned char *, unsigned long *);
1244extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
1245extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
1246extern int hash_sha1_file_literally(const void *buf, unsigned long len, const char *type, struct object_id *oid, unsigned flags);
1247extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
1248extern int force_object_loose(const unsigned char *sha1, time_t mtime);
1249extern int git_open_cloexec(const char *name, int flags);
1250#define git_open(name) git_open_cloexec(name, O_RDONLY)
1251extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
1252extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
1253extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
1254
1255extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
1256
1257extern int finalize_object_file(const char *tmpfile, const char *filename);
1258
1259/*
1260 * Open the loose object at path, check its sha1, and return the contents,
1261 * type, and size. If the object is a blob, then "contents" may return NULL,
1262 * to allow streaming of large blobs.
1263 *
1264 * Returns 0 on success, negative on error (details may be written to stderr).
1265 */
1266int read_loose_object(const char *path,
1267                      const unsigned char *expected_sha1,
1268                      enum object_type *type,
1269                      unsigned long *size,
1270                      void **contents);
1271
1272/*
1273 * Convenience for sha1_object_info_extended() with a NULL struct
1274 * object_info. OBJECT_INFO_SKIP_CACHED is automatically set; pass
1275 * nonzero flags to also set other flags.
1276 */
1277extern int has_sha1_file_with_flags(const unsigned char *sha1, int flags);
1278static inline int has_sha1_file(const unsigned char *sha1)
1279{
1280        return has_sha1_file_with_flags(sha1, 0);
1281}
1282
1283/* Same as the above, except for struct object_id. */
1284extern int has_object_file(const struct object_id *oid);
1285extern int has_object_file_with_flags(const struct object_id *oid, int flags);
1286
1287/*
1288 * Return true iff an alternate object database has a loose object
1289 * with the specified name.  This function does not respect replace
1290 * references.
1291 */
1292extern int has_loose_object_nonlocal(const unsigned char *sha1);
1293
1294extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
1295
1296/* Helper to check and "touch" a file */
1297extern int check_and_freshen_file(const char *fn, int freshen);
1298
1299extern const signed char hexval_table[256];
1300static inline unsigned int hexval(unsigned char c)
1301{
1302        return hexval_table[c];
1303}
1304
1305/*
1306 * Convert two consecutive hexadecimal digits into a char.  Return a
1307 * negative value on error.  Don't run over the end of short strings.
1308 */
1309static inline int hex2chr(const char *s)
1310{
1311        unsigned int val = hexval(s[0]);
1312        return (val & ~0xf) ? val : (val << 4) | hexval(s[1]);
1313}
1314
1315/* Convert to/from hex/sha1 representation */
1316#define MINIMUM_ABBREV minimum_abbrev
1317#define DEFAULT_ABBREV default_abbrev
1318
1319/* used when the code does not know or care what the default abbrev is */
1320#define FALLBACK_DEFAULT_ABBREV 7
1321
1322struct object_context {
1323        unsigned char tree[20];
1324        unsigned mode;
1325        /*
1326         * symlink_path is only used by get_tree_entry_follow_symlinks,
1327         * and only for symlinks that point outside the repository.
1328         */
1329        struct strbuf symlink_path;
1330        /*
1331         * If GET_OID_RECORD_PATH is set, this will record path (if any)
1332         * found when resolving the name. The caller is responsible for
1333         * releasing the memory.
1334         */
1335        char *path;
1336};
1337
1338#define GET_OID_QUIETLY           01
1339#define GET_OID_COMMIT            02
1340#define GET_OID_COMMITTISH        04
1341#define GET_OID_TREE             010
1342#define GET_OID_TREEISH          020
1343#define GET_OID_BLOB             040
1344#define GET_OID_FOLLOW_SYMLINKS 0100
1345#define GET_OID_RECORD_PATH     0200
1346#define GET_OID_ONLY_TO_DIE    04000
1347
1348#define GET_OID_DISAMBIGUATORS \
1349        (GET_OID_COMMIT | GET_OID_COMMITTISH | \
1350        GET_OID_TREE | GET_OID_TREEISH | \
1351        GET_OID_BLOB)
1352
1353extern int get_oid(const char *str, struct object_id *oid);
1354extern int get_oid_commit(const char *str, struct object_id *oid);
1355extern int get_oid_committish(const char *str, struct object_id *oid);
1356extern int get_oid_tree(const char *str, struct object_id *oid);
1357extern int get_oid_treeish(const char *str, struct object_id *oid);
1358extern int get_oid_blob(const char *str, struct object_id *oid);
1359extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
1360extern int get_oid_with_context(const char *str, unsigned flags, struct object_id *oid, struct object_context *oc);
1361
1362
1363typedef int each_abbrev_fn(const struct object_id *oid, void *);
1364extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
1365
1366extern int set_disambiguate_hint_config(const char *var, const char *value);
1367
1368/*
1369 * Try to read a SHA1 in hexadecimal format from the 40 characters
1370 * starting at hex.  Write the 20-byte result to sha1 in binary form.
1371 * Return 0 on success.  Reading stops if a NUL is encountered in the
1372 * input, so it is safe to pass this function an arbitrary
1373 * null-terminated string.
1374 */
1375extern int get_sha1_hex(const char *hex, unsigned char *sha1);
1376extern int get_oid_hex(const char *hex, struct object_id *sha1);
1377
1378/*
1379 * Read `len` pairs of hexadecimal digits from `hex` and write the
1380 * values to `binary` as `len` bytes. Return 0 on success, or -1 if
1381 * the input does not consist of hex digits).
1382 */
1383extern int hex_to_bytes(unsigned char *binary, const char *hex, size_t len);
1384
1385/*
1386 * Convert a binary sha1 to its hex equivalent. The `_r` variant is reentrant,
1387 * and writes the NUL-terminated output to the buffer `out`, which must be at
1388 * least `GIT_SHA1_HEXSZ + 1` bytes, and returns a pointer to out for
1389 * convenience.
1390 *
1391 * The non-`_r` variant returns a static buffer, but uses a ring of 4
1392 * buffers, making it safe to make multiple calls for a single statement, like:
1393 *
1394 *   printf("%s -> %s", sha1_to_hex(one), sha1_to_hex(two));
1395 */
1396extern char *sha1_to_hex_r(char *out, const unsigned char *sha1);
1397extern char *oid_to_hex_r(char *out, const struct object_id *oid);
1398extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
1399extern char *oid_to_hex(const struct object_id *oid);   /* same static buffer as sha1_to_hex */
1400
1401/*
1402 * Parse a 40-character hexadecimal object ID starting from hex, updating the
1403 * pointer specified by end when parsing stops.  The resulting object ID is
1404 * stored in oid.  Returns 0 on success.  Parsing will stop on the first NUL or
1405 * other invalid character.  end is only updated on success; otherwise, it is
1406 * unmodified.
1407 */
1408extern int parse_oid_hex(const char *hex, struct object_id *oid, const char **end);
1409
1410/*
1411 * This reads short-hand syntax that not only evaluates to a commit
1412 * object name, but also can act as if the end user spelled the name
1413 * of the branch from the command line.
1414 *
1415 * - "@{-N}" finds the name of the Nth previous branch we were on, and
1416 *   places the name of the branch in the given buf and returns the
1417 *   number of characters parsed if successful.
1418 *
1419 * - "<branch>@{upstream}" finds the name of the other ref that
1420 *   <branch> is configured to merge with (missing <branch> defaults
1421 *   to the current branch), and places the name of the branch in the
1422 *   given buf and returns the number of characters parsed if
1423 *   successful.
1424 *
1425 * If the input is not of the accepted format, it returns a negative
1426 * number to signal an error.
1427 *
1428 * If the input was ok but there are not N branch switches in the
1429 * reflog, it returns 0.
1430 *
1431 * If "allowed" is non-zero, it is a treated as a bitfield of allowable
1432 * expansions: local branches ("refs/heads/"), remote branches
1433 * ("refs/remotes/"), or "HEAD". If no "allowed" bits are set, any expansion is
1434 * allowed, even ones to refs outside of those namespaces.
1435 */
1436#define INTERPRET_BRANCH_LOCAL (1<<0)
1437#define INTERPRET_BRANCH_REMOTE (1<<1)
1438#define INTERPRET_BRANCH_HEAD (1<<2)
1439extern int interpret_branch_name(const char *str, int len, struct strbuf *,
1440                                 unsigned allowed);
1441extern int get_oid_mb(const char *str, struct object_id *oid);
1442
1443extern int validate_headref(const char *ref);
1444
1445extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1446extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1447extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1448extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1449
1450extern void *read_object_with_reference(const unsigned char *sha1,
1451                                        const char *required_type,
1452                                        unsigned long *size,
1453                                        unsigned char *sha1_ret);
1454
1455extern struct object *peel_to_type(const char *name, int namelen,
1456                                   struct object *o, enum object_type);
1457
1458struct date_mode {
1459        enum date_mode_type {
1460                DATE_NORMAL = 0,
1461                DATE_RELATIVE,
1462                DATE_SHORT,
1463                DATE_ISO8601,
1464                DATE_ISO8601_STRICT,
1465                DATE_RFC2822,
1466                DATE_STRFTIME,
1467                DATE_RAW,
1468                DATE_UNIX
1469        } type;
1470        const char *strftime_fmt;
1471        int local;
1472};
1473
1474/*
1475 * Convenience helper for passing a constant type, like:
1476 *
1477 *   show_date(t, tz, DATE_MODE(NORMAL));
1478 */
1479#define DATE_MODE(t) date_mode_from_type(DATE_##t)
1480struct date_mode *date_mode_from_type(enum date_mode_type type);
1481
1482const char *show_date(timestamp_t time, int timezone, const struct date_mode *mode);
1483void show_date_relative(timestamp_t time, int tz, const struct timeval *now,
1484                        struct strbuf *timebuf);
1485int parse_date(const char *date, struct strbuf *out);
1486int parse_date_basic(const char *date, timestamp_t *timestamp, int *offset);
1487int parse_expiry_date(const char *date, timestamp_t *timestamp);
1488void datestamp(struct strbuf *out);
1489#define approxidate(s) approxidate_careful((s), NULL)
1490timestamp_t approxidate_careful(const char *, int *);
1491timestamp_t approxidate_relative(const char *date, const struct timeval *now);
1492void parse_date_format(const char *format, struct date_mode *mode);
1493int date_overflows(timestamp_t date);
1494
1495#define IDENT_STRICT           1
1496#define IDENT_NO_DATE          2
1497#define IDENT_NO_NAME          4
1498extern const char *git_author_info(int);
1499extern const char *git_committer_info(int);
1500extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1501extern const char *fmt_name(const char *name, const char *email);
1502extern const char *ident_default_name(void);
1503extern const char *ident_default_email(void);
1504extern const char *git_editor(void);
1505extern const char *git_pager(int stdout_is_tty);
1506extern int is_terminal_dumb(void);
1507extern int git_ident_config(const char *, const char *, void *);
1508extern void reset_ident_date(void);
1509
1510struct ident_split {
1511        const char *name_begin;
1512        const char *name_end;
1513        const char *mail_begin;
1514        const char *mail_end;
1515        const char *date_begin;
1516        const char *date_end;
1517        const char *tz_begin;
1518        const char *tz_end;
1519};
1520/*
1521 * Signals an success with 0, but time part of the result may be NULL
1522 * if the input lacks timestamp and zone
1523 */
1524extern int split_ident_line(struct ident_split *, const char *, int);
1525
1526/*
1527 * Like show_date, but pull the timestamp and tz parameters from
1528 * the ident_split. It will also sanity-check the values and produce
1529 * a well-known sentinel date if they appear bogus.
1530 */
1531const char *show_ident_date(const struct ident_split *id,
1532                            const struct date_mode *mode);
1533
1534/*
1535 * Compare split idents for equality or strict ordering. Note that we
1536 * compare only the ident part of the line, ignoring any timestamp.
1537 *
1538 * Because there are two fields, we must choose one as the primary key; we
1539 * currently arbitrarily pick the email.
1540 */
1541extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1542
1543struct checkout {
1544        struct index_state *istate;
1545        const char *base_dir;
1546        int base_dir_len;
1547        struct delayed_checkout *delayed_checkout;
1548        unsigned force:1,
1549                 quiet:1,
1550                 not_new:1,
1551                 refresh_cache:1;
1552};
1553#define CHECKOUT_INIT { NULL, "" }
1554
1555#define TEMPORARY_FILENAME_LENGTH 25
1556extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1557extern void enable_delayed_checkout(struct checkout *state);
1558extern int finish_delayed_checkout(struct checkout *state);
1559
1560struct cache_def {
1561        struct strbuf path;
1562        int flags;
1563        int track_flags;
1564        int prefix_len_stat_func;
1565};
1566#define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1567static inline void cache_def_clear(struct cache_def *cache)
1568{
1569        strbuf_release(&cache->path);
1570}
1571
1572extern int has_symlink_leading_path(const char *name, int len);
1573extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1574extern int check_leading_path(const char *name, int len);
1575extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1576extern void schedule_dir_for_removal(const char *name, int len);
1577extern void remove_scheduled_dirs(void);
1578
1579extern struct alternate_object_database {
1580        struct alternate_object_database *next;
1581
1582        /* see alt_scratch_buf() */
1583        struct strbuf scratch;
1584        size_t base_len;
1585
1586        /*
1587         * Used to store the results of readdir(3) calls when searching
1588         * for unique abbreviated hashes.  This cache is never
1589         * invalidated, thus it's racy and not necessarily accurate.
1590         * That's fine for its purpose; don't use it for tasks requiring
1591         * greater accuracy!
1592         */
1593        char loose_objects_subdir_seen[256];
1594        struct oid_array loose_objects_cache;
1595
1596        char path[FLEX_ARRAY];
1597} *alt_odb_list;
1598extern void prepare_alt_odb(void);
1599extern char *compute_alternate_path(const char *path, struct strbuf *err);
1600typedef int alt_odb_fn(struct alternate_object_database *, void *);
1601extern int foreach_alt_odb(alt_odb_fn, void*);
1602
1603/*
1604 * Allocate a "struct alternate_object_database" but do _not_ actually
1605 * add it to the list of alternates.
1606 */
1607struct alternate_object_database *alloc_alt_odb(const char *dir);
1608
1609/*
1610 * Add the directory to the on-disk alternates file; the new entry will also
1611 * take effect in the current process.
1612 */
1613extern void add_to_alternates_file(const char *dir);
1614
1615/*
1616 * Add the directory to the in-memory list of alternates (along with any
1617 * recursive alternates it points to), but do not modify the on-disk alternates
1618 * file.
1619 */
1620extern void add_to_alternates_memory(const char *dir);
1621
1622/*
1623 * Returns a scratch strbuf pre-filled with the alternate object directory,
1624 * including a trailing slash, which can be used to access paths in the
1625 * alternate. Always use this over direct access to alt->scratch, as it
1626 * cleans up any previous use of the scratch buffer.
1627 */
1628extern struct strbuf *alt_scratch_buf(struct alternate_object_database *alt);
1629
1630struct pack_window {
1631        struct pack_window *next;
1632        unsigned char *base;
1633        off_t offset;
1634        size_t len;
1635        unsigned int last_used;
1636        unsigned int inuse_cnt;
1637};
1638
1639extern struct packed_git {
1640        struct packed_git *next;
1641        struct list_head mru;
1642        struct pack_window *windows;
1643        off_t pack_size;
1644        const void *index_data;
1645        size_t index_size;
1646        uint32_t num_objects;
1647        uint32_t num_bad_objects;
1648        unsigned char *bad_object_sha1;
1649        int index_version;
1650        time_t mtime;
1651        int pack_fd;
1652        unsigned pack_local:1,
1653                 pack_keep:1,
1654                 freshened:1,
1655                 do_not_close:1,
1656                 pack_promisor:1;
1657        unsigned char sha1[20];
1658        struct revindex_entry *revindex;
1659        /* something like ".git/objects/pack/xxxxx.pack" */
1660        char pack_name[FLEX_ARRAY]; /* more */
1661} *packed_git;
1662
1663/*
1664 * A most-recently-used ordered version of the packed_git list.
1665 */
1666extern struct list_head packed_git_mru;
1667
1668struct pack_entry {
1669        off_t offset;
1670        unsigned char sha1[20];
1671        struct packed_git *p;
1672};
1673
1674/*
1675 * Create a temporary file rooted in the object database directory, or
1676 * die on failure. The filename is taken from "pattern", which should have the
1677 * usual "XXXXXX" trailer, and the resulting filename is written into the
1678 * "template" buffer. Returns the open descriptor.
1679 */
1680extern int odb_mkstemp(struct strbuf *template, const char *pattern);
1681
1682/*
1683 * Create a pack .keep file named "name" (which should generally be the output
1684 * of odb_pack_name). Returns a file descriptor opened for writing, or -1 on
1685 * error.
1686 */
1687extern int odb_pack_keep(const char *name);
1688
1689/*
1690 * Iterate over the files in the loose-object parts of the object
1691 * directory "path", triggering the following callbacks:
1692 *
1693 *  - loose_object is called for each loose object we find.
1694 *
1695 *  - loose_cruft is called for any files that do not appear to be
1696 *    loose objects. Note that we only look in the loose object
1697 *    directories "objects/[0-9a-f]{2}/", so we will not report
1698 *    "objects/foobar" as cruft.
1699 *
1700 *  - loose_subdir is called for each top-level hashed subdirectory
1701 *    of the object directory (e.g., "$OBJDIR/f0"). It is called
1702 *    after the objects in the directory are processed.
1703 *
1704 * Any callback that is NULL will be ignored. Callbacks returning non-zero
1705 * will end the iteration.
1706 *
1707 * In the "buf" variant, "path" is a strbuf which will also be used as a
1708 * scratch buffer, but restored to its original contents before
1709 * the function returns.
1710 */
1711typedef int each_loose_object_fn(const struct object_id *oid,
1712                                 const char *path,
1713                                 void *data);
1714typedef int each_loose_cruft_fn(const char *basename,
1715                                const char *path,
1716                                void *data);
1717typedef int each_loose_subdir_fn(unsigned int nr,
1718                                 const char *path,
1719                                 void *data);
1720int for_each_file_in_obj_subdir(unsigned int subdir_nr,
1721                                struct strbuf *path,
1722                                each_loose_object_fn obj_cb,
1723                                each_loose_cruft_fn cruft_cb,
1724                                each_loose_subdir_fn subdir_cb,
1725                                void *data);
1726int for_each_loose_file_in_objdir(const char *path,
1727                                  each_loose_object_fn obj_cb,
1728                                  each_loose_cruft_fn cruft_cb,
1729                                  each_loose_subdir_fn subdir_cb,
1730                                  void *data);
1731int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1732                                      each_loose_object_fn obj_cb,
1733                                      each_loose_cruft_fn cruft_cb,
1734                                      each_loose_subdir_fn subdir_cb,
1735                                      void *data);
1736
1737/*
1738 * Iterate over loose objects in both the local
1739 * repository and any alternates repositories (unless the
1740 * LOCAL_ONLY flag is set).
1741 */
1742#define FOR_EACH_OBJECT_LOCAL_ONLY 0x1
1743extern int for_each_loose_object(each_loose_object_fn, void *, unsigned flags);
1744
1745struct object_info {
1746        /* Request */
1747        enum object_type *typep;
1748        unsigned long *sizep;
1749        off_t *disk_sizep;
1750        unsigned char *delta_base_sha1;
1751        struct strbuf *typename;
1752        void **contentp;
1753
1754        /* Response */
1755        enum {
1756                OI_CACHED,
1757                OI_LOOSE,
1758                OI_PACKED,
1759                OI_DBCACHED
1760        } whence;
1761        union {
1762                /*
1763                 * struct {
1764                 *      ... Nothing to expose in this case
1765                 * } cached;
1766                 * struct {
1767                 *      ... Nothing to expose in this case
1768                 * } loose;
1769                 */
1770                struct {
1771                        struct packed_git *pack;
1772                        off_t offset;
1773                        unsigned int is_delta;
1774                } packed;
1775        } u;
1776};
1777
1778/*
1779 * Initializer for a "struct object_info" that wants no items. You may
1780 * also memset() the memory to all-zeroes.
1781 */
1782#define OBJECT_INFO_INIT {NULL}
1783
1784/* Invoke lookup_replace_object() on the given hash */
1785#define OBJECT_INFO_LOOKUP_REPLACE 1
1786/* Allow reading from a loose object file of unknown/bogus type */
1787#define OBJECT_INFO_ALLOW_UNKNOWN_TYPE 2
1788/* Do not check cached storage */
1789#define OBJECT_INFO_SKIP_CACHED 4
1790/* Do not retry packed storage after checking packed and loose storage */
1791#define OBJECT_INFO_QUICK 8
1792extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1793
1794/*
1795 * Set this to 0 to prevent sha1_object_info_extended() from fetching missing
1796 * blobs. This has a difference only if extensions.partialClone is set.
1797 *
1798 * Its default value is 1.
1799 */
1800extern int fetch_if_missing;
1801
1802/* Dumb servers support */
1803extern int update_server_info(int);
1804
1805extern const char *get_log_output_encoding(void);
1806extern const char *get_commit_output_encoding(void);
1807
1808/*
1809 * This is a hack for test programs like test-dump-untracked-cache to
1810 * ensure that they do not modify the untracked cache when reading it.
1811 * Do not use it otherwise!
1812 */
1813extern int ignore_untracked_cache_config;
1814
1815extern int committer_ident_sufficiently_given(void);
1816extern int author_ident_sufficiently_given(void);
1817
1818extern const char *git_commit_encoding;
1819extern const char *git_log_output_encoding;
1820extern const char *git_mailmap_file;
1821extern const char *git_mailmap_blob;
1822
1823/* IO helper functions */
1824extern void maybe_flush_or_die(FILE *, const char *);
1825__attribute__((format (printf, 2, 3)))
1826extern void fprintf_or_die(FILE *, const char *fmt, ...);
1827
1828#define COPY_READ_ERROR (-2)
1829#define COPY_WRITE_ERROR (-3)
1830extern int copy_fd(int ifd, int ofd);
1831extern int copy_file(const char *dst, const char *src, int mode);
1832extern int copy_file_with_time(const char *dst, const char *src, int mode);
1833
1834extern void write_or_die(int fd, const void *buf, size_t count);
1835extern void fsync_or_die(int fd, const char *);
1836
1837extern ssize_t read_in_full(int fd, void *buf, size_t count);
1838extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1839extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1840
1841static inline ssize_t write_str_in_full(int fd, const char *str)
1842{
1843        return write_in_full(fd, str, strlen(str));
1844}
1845
1846/**
1847 * Open (and truncate) the file at path, write the contents of buf to it,
1848 * and close it. Dies if any errors are encountered.
1849 */
1850extern void write_file_buf(const char *path, const char *buf, size_t len);
1851
1852/**
1853 * Like write_file_buf(), but format the contents into a buffer first.
1854 * Additionally, write_file() will append a newline if one is not already
1855 * present, making it convenient to write text files:
1856 *
1857 *   write_file(path, "counter: %d", ctr);
1858 */
1859__attribute__((format (printf, 2, 3)))
1860extern void write_file(const char *path, const char *fmt, ...);
1861
1862/* pager.c */
1863extern void setup_pager(void);
1864extern int pager_in_use(void);
1865extern int pager_use_color;
1866extern int term_columns(void);
1867extern int decimal_width(uintmax_t);
1868extern int check_pager_config(const char *cmd);
1869extern void prepare_pager_args(struct child_process *, const char *pager);
1870
1871extern const char *editor_program;
1872extern const char *askpass_program;
1873extern const char *excludes_file;
1874
1875/* base85 */
1876int decode_85(char *dst, const char *line, int linelen);
1877void encode_85(char *buf, const unsigned char *data, int bytes);
1878
1879/* alloc.c */
1880extern void *alloc_blob_node(void);
1881extern void *alloc_tree_node(void);
1882extern void *alloc_commit_node(void);
1883extern void *alloc_tag_node(void);
1884extern void *alloc_object_node(void);
1885extern void alloc_report(void);
1886extern unsigned int alloc_commit_index(void);
1887
1888/* pkt-line.c */
1889void packet_trace_identity(const char *prog);
1890
1891/* add */
1892/*
1893 * return 0 if success, 1 - if addition of a file failed and
1894 * ADD_FILES_IGNORE_ERRORS was specified in flags
1895 */
1896int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1897
1898/* diff.c */
1899extern int diff_auto_refresh_index;
1900
1901/* match-trees.c */
1902void shift_tree(const struct object_id *, const struct object_id *, struct object_id *, int);
1903void shift_tree_by(const struct object_id *, const struct object_id *, struct object_id *, const char *);
1904
1905/*
1906 * whitespace rules.
1907 * used by both diff and apply
1908 * last two digits are tab width
1909 */
1910#define WS_BLANK_AT_EOL         0100
1911#define WS_SPACE_BEFORE_TAB     0200
1912#define WS_INDENT_WITH_NON_TAB  0400
1913#define WS_CR_AT_EOL           01000
1914#define WS_BLANK_AT_EOF        02000
1915#define WS_TAB_IN_INDENT       04000
1916#define WS_TRAILING_SPACE      (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1917#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1918#define WS_TAB_WIDTH_MASK        077
1919/* All WS_* -- when extended, adapt diff.c emit_symbol */
1920#define WS_RULE_MASK           07777
1921extern unsigned whitespace_rule_cfg;
1922extern unsigned whitespace_rule(const char *);
1923extern unsigned parse_whitespace_rule(const char *);
1924extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1925extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1926extern char *whitespace_error_string(unsigned ws);
1927extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1928extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1929#define ws_tab_width(rule)     ((rule) & WS_TAB_WIDTH_MASK)
1930
1931/* ls-files */
1932void overlay_tree_on_index(struct index_state *istate,
1933                           const char *tree_name, const char *prefix);
1934
1935char *alias_lookup(const char *alias);
1936int split_cmdline(char *cmdline, const char ***argv);
1937/* Takes a negative value returned by split_cmdline */
1938const char *split_cmdline_strerror(int cmdline_errno);
1939
1940/* setup.c */
1941struct startup_info {
1942        int have_repository;
1943        const char *prefix;
1944};
1945extern struct startup_info *startup_info;
1946
1947/* merge.c */
1948struct commit_list;
1949int try_merge_command(const char *strategy, size_t xopts_nr,
1950                const char **xopts, struct commit_list *common,
1951                const char *head_arg, struct commit_list *remotes);
1952int checkout_fast_forward(const struct object_id *from,
1953                          const struct object_id *to,
1954                          int overwrite_ignore);
1955
1956
1957int sane_execvp(const char *file, char *const argv[]);
1958
1959/*
1960 * A struct to encapsulate the concept of whether a file has changed
1961 * since we last checked it. This uses criteria similar to those used
1962 * for the index.
1963 */
1964struct stat_validity {
1965        struct stat_data *sd;
1966};
1967
1968void stat_validity_clear(struct stat_validity *sv);
1969
1970/*
1971 * Returns 1 if the path is a regular file (or a symlink to a regular
1972 * file) and matches the saved stat_validity, 0 otherwise.  A missing
1973 * or inaccessible file is considered a match if the struct was just
1974 * initialized, or if the previous update found an inaccessible file.
1975 */
1976int stat_validity_check(struct stat_validity *sv, const char *path);
1977
1978/*
1979 * Update the stat_validity from a file opened at descriptor fd. If
1980 * the file is missing, inaccessible, or not a regular file, then
1981 * future calls to stat_validity_check will match iff one of those
1982 * conditions continues to be true.
1983 */
1984void stat_validity_update(struct stat_validity *sv, int fd);
1985
1986int versioncmp(const char *s1, const char *s2);
1987void sleep_millisec(int millisec);
1988
1989/*
1990 * Create a directory and (if share is nonzero) adjust its permissions
1991 * according to the shared_repository setting. Only use this for
1992 * directories under $GIT_DIR.  Don't use it for working tree
1993 * directories.
1994 */
1995void safe_create_dir(const char *dir, int share);
1996
1997/*
1998 * Should we print an ellipsis after an abbreviated SHA-1 value
1999 * when doing diff-raw output or indicating a detached HEAD?
2000 */
2001extern int print_sha1_ellipsis(void);
2002
2003#endif /* CACHE_H */