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