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