cache.hon commit ls-remote doc: rewrite <repository> paragraph (88e3614)
   1#ifndef CACHE_H
   2#define CACHE_H
   3
   4#include "git-compat-util.h"
   5#include "strbuf.h"
   6#include "hash.h"
   7#include "advice.h"
   8#include "gettext.h"
   9#include "convert.h"
  10
  11#include SHA1_HEADER
  12#ifndef git_SHA_CTX
  13#define git_SHA_CTX     SHA_CTX
  14#define git_SHA1_Init   SHA1_Init
  15#define git_SHA1_Update SHA1_Update
  16#define git_SHA1_Final  SHA1_Final
  17#endif
  18
  19#include <zlib.h>
  20typedef struct git_zstream {
  21        z_stream z;
  22        unsigned long avail_in;
  23        unsigned long avail_out;
  24        unsigned long total_in;
  25        unsigned long total_out;
  26        unsigned char *next_in;
  27        unsigned char *next_out;
  28} git_zstream;
  29
  30void git_inflate_init(git_zstream *);
  31void git_inflate_init_gzip_only(git_zstream *);
  32void git_inflate_end(git_zstream *);
  33int git_inflate(git_zstream *, int flush);
  34
  35void git_deflate_init(git_zstream *, int level);
  36void git_deflate_init_gzip(git_zstream *, int level);
  37void git_deflate_init_raw(git_zstream *, int level);
  38void git_deflate_end(git_zstream *);
  39int git_deflate_abort(git_zstream *);
  40int git_deflate_end_gently(git_zstream *);
  41int git_deflate(git_zstream *, int flush);
  42unsigned long git_deflate_bound(git_zstream *, unsigned long);
  43
  44#if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
  45#define DTYPE(de)       ((de)->d_type)
  46#else
  47#undef DT_UNKNOWN
  48#undef DT_DIR
  49#undef DT_REG
  50#undef DT_LNK
  51#define DT_UNKNOWN      0
  52#define DT_DIR          1
  53#define DT_REG          2
  54#define DT_LNK          3
  55#define DTYPE(de)       DT_UNKNOWN
  56#endif
  57
  58/* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
  59#define S_IFINVALID     0030000
  60
  61/*
  62 * A "directory link" is a link to another git directory.
  63 *
  64 * The value 0160000 is not normally a valid mode, and
  65 * also just happens to be S_IFDIR + S_IFLNK
  66 *
  67 * NOTE! We *really* shouldn't depend on the S_IFxxx macros
  68 * always having the same values everywhere. We should use
  69 * our internal git values for these things, and then we can
  70 * translate that to the OS-specific value. It just so
  71 * happens that everybody shares the same bit representation
  72 * in the UNIX world (and apparently wider too..)
  73 */
  74#define S_IFGITLINK     0160000
  75#define S_ISGITLINK(m)  (((m) & S_IFMT) == S_IFGITLINK)
  76
  77/*
  78 * Intensive research over the course of many years has shown that
  79 * port 9418 is totally unused by anything else. Or
  80 *
  81 *      Your search - "port 9418" - did not match any documents.
  82 *
  83 * as www.google.com puts it.
  84 *
  85 * This port has been properly assigned for git use by IANA:
  86 * git (Assigned-9418) [I06-050728-0001].
  87 *
  88 *      git  9418/tcp   git pack transfer service
  89 *      git  9418/udp   git pack transfer service
  90 *
  91 * with Linus Torvalds <torvalds@osdl.org> as the point of
  92 * contact. September 2005.
  93 *
  94 * See http://www.iana.org/assignments/port-numbers
  95 */
  96#define DEFAULT_GIT_PORT 9418
  97
  98/*
  99 * Basic data structures for the directory cache
 100 */
 101
 102#define CACHE_SIGNATURE 0x44495243      /* "DIRC" */
 103struct cache_header {
 104        unsigned int hdr_signature;
 105        unsigned int hdr_version;
 106        unsigned int hdr_entries;
 107};
 108
 109#define INDEX_FORMAT_LB 2
 110#define INDEX_FORMAT_UB 4
 111
 112/*
 113 * The "cache_time" is just the low 32 bits of the
 114 * time. It doesn't matter if it overflows - we only
 115 * check it for equality in the 32 bits we save.
 116 */
 117struct cache_time {
 118        unsigned int sec;
 119        unsigned int nsec;
 120};
 121
 122struct cache_entry {
 123        struct cache_time ce_ctime;
 124        struct cache_time ce_mtime;
 125        unsigned int ce_dev;
 126        unsigned int ce_ino;
 127        unsigned int ce_mode;
 128        unsigned int ce_uid;
 129        unsigned int ce_gid;
 130        unsigned int ce_size;
 131        unsigned int ce_flags;
 132        unsigned int ce_namelen;
 133        unsigned char sha1[20];
 134        struct cache_entry *next;
 135        char name[FLEX_ARRAY]; /* more */
 136};
 137
 138#define CE_STAGEMASK (0x3000)
 139#define CE_EXTENDED  (0x4000)
 140#define CE_VALID     (0x8000)
 141#define CE_STAGESHIFT 12
 142
 143/*
 144 * Range 0xFFFF0000 in ce_flags is divided into
 145 * two parts: in-memory flags and on-disk ones.
 146 * Flags in CE_EXTENDED_FLAGS will get saved on-disk
 147 * if you want to save a new flag, add it in
 148 * CE_EXTENDED_FLAGS
 149 *
 150 * In-memory only flags
 151 */
 152#define CE_UPDATE            (1 << 16)
 153#define CE_REMOVE            (1 << 17)
 154#define CE_UPTODATE          (1 << 18)
 155#define CE_ADDED             (1 << 19)
 156
 157#define CE_HASHED            (1 << 20)
 158#define CE_UNHASHED          (1 << 21)
 159#define CE_WT_REMOVE         (1 << 22) /* remove in work directory */
 160#define CE_CONFLICTED        (1 << 23)
 161
 162#define CE_UNPACKED          (1 << 24)
 163#define CE_NEW_SKIP_WORKTREE (1 << 25)
 164
 165/* used to temporarily mark paths matched by pathspecs */
 166#define CE_MATCHED           (1 << 26)
 167
 168/*
 169 * Extended on-disk flags
 170 */
 171#define CE_INTENT_TO_ADD     (1 << 29)
 172#define CE_SKIP_WORKTREE     (1 << 30)
 173/* CE_EXTENDED2 is for future extension */
 174#define CE_EXTENDED2         (1 << 31)
 175
 176#define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
 177
 178/*
 179 * Safeguard to avoid saving wrong flags:
 180 *  - CE_EXTENDED2 won't get saved until its semantic is known
 181 *  - Bits in 0x0000FFFF have been saved in ce_flags already
 182 *  - Bits in 0x003F0000 are currently in-memory flags
 183 */
 184#if CE_EXTENDED_FLAGS & 0x803FFFFF
 185#error "CE_EXTENDED_FLAGS out of range"
 186#endif
 187
 188/*
 189 * Copy the sha1 and stat state of a cache entry from one to
 190 * another. But we never change the name, or the hash state!
 191 */
 192#define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
 193static inline void copy_cache_entry(struct cache_entry *dst,
 194                                    const struct cache_entry *src)
 195{
 196        unsigned int state = dst->ce_flags & CE_STATE_MASK;
 197
 198        /* Don't copy hash chain and name */
 199        memcpy(dst, src, offsetof(struct cache_entry, next));
 200
 201        /* Restore the hash state */
 202        dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
 203}
 204
 205static inline unsigned create_ce_flags(unsigned stage)
 206{
 207        return (stage << CE_STAGESHIFT);
 208}
 209
 210#define ce_namelen(ce) ((ce)->ce_namelen)
 211#define ce_size(ce) cache_entry_size(ce_namelen(ce))
 212#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
 213#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
 214#define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
 215#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
 216
 217#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
 218static inline unsigned int create_ce_mode(unsigned int mode)
 219{
 220        if (S_ISLNK(mode))
 221                return S_IFLNK;
 222        if (S_ISDIR(mode) || S_ISGITLINK(mode))
 223                return S_IFGITLINK;
 224        return S_IFREG | ce_permissions(mode);
 225}
 226static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
 227                                             unsigned int mode)
 228{
 229        extern int trust_executable_bit, has_symlinks;
 230        if (!has_symlinks && S_ISREG(mode) &&
 231            ce && S_ISLNK(ce->ce_mode))
 232                return ce->ce_mode;
 233        if (!trust_executable_bit && S_ISREG(mode)) {
 234                if (ce && S_ISREG(ce->ce_mode))
 235                        return ce->ce_mode;
 236                return create_ce_mode(0666);
 237        }
 238        return create_ce_mode(mode);
 239}
 240static inline int ce_to_dtype(const struct cache_entry *ce)
 241{
 242        unsigned ce_mode = ntohl(ce->ce_mode);
 243        if (S_ISREG(ce_mode))
 244                return DT_REG;
 245        else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
 246                return DT_DIR;
 247        else if (S_ISLNK(ce_mode))
 248                return DT_LNK;
 249        else
 250                return DT_UNKNOWN;
 251}
 252static inline unsigned int canon_mode(unsigned int mode)
 253{
 254        if (S_ISREG(mode))
 255                return S_IFREG | ce_permissions(mode);
 256        if (S_ISLNK(mode))
 257                return S_IFLNK;
 258        if (S_ISDIR(mode))
 259                return S_IFDIR;
 260        return S_IFGITLINK;
 261}
 262
 263#define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
 264
 265struct index_state {
 266        struct cache_entry **cache;
 267        unsigned int version;
 268        unsigned int cache_nr, cache_alloc, cache_changed;
 269        struct string_list *resolve_undo;
 270        struct cache_tree *cache_tree;
 271        struct cache_time timestamp;
 272        unsigned name_hash_initialized : 1,
 273                 initialized : 1;
 274        struct hash_table name_hash;
 275        struct hash_table dir_hash;
 276};
 277
 278extern struct index_state the_index;
 279
 280/* Name hashing */
 281extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
 282extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
 283extern void free_name_hash(struct index_state *istate);
 284
 285
 286#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
 287#define active_cache (the_index.cache)
 288#define active_nr (the_index.cache_nr)
 289#define active_alloc (the_index.cache_alloc)
 290#define active_cache_changed (the_index.cache_changed)
 291#define active_cache_tree (the_index.cache_tree)
 292
 293#define read_cache() read_index(&the_index)
 294#define read_cache_from(path) read_index_from(&the_index, (path))
 295#define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
 296#define is_cache_unborn() is_index_unborn(&the_index)
 297#define read_cache_unmerged() read_index_unmerged(&the_index)
 298#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
 299#define discard_cache() discard_index(&the_index)
 300#define unmerged_cache() unmerged_index(&the_index)
 301#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
 302#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
 303#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
 304#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
 305#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
 306#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
 307#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
 308#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
 309#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
 310#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
 311#define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
 312#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
 313#define resolve_undo_clear() resolve_undo_clear_index(&the_index)
 314#define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
 315#define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
 316#define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
 317#endif
 318
 319enum object_type {
 320        OBJ_BAD = -1,
 321        OBJ_NONE = 0,
 322        OBJ_COMMIT = 1,
 323        OBJ_TREE = 2,
 324        OBJ_BLOB = 3,
 325        OBJ_TAG = 4,
 326        /* 5 for future expansion */
 327        OBJ_OFS_DELTA = 6,
 328        OBJ_REF_DELTA = 7,
 329        OBJ_ANY,
 330        OBJ_MAX
 331};
 332
 333static inline enum object_type object_type(unsigned int mode)
 334{
 335        return S_ISDIR(mode) ? OBJ_TREE :
 336                S_ISGITLINK(mode) ? OBJ_COMMIT :
 337                OBJ_BLOB;
 338}
 339
 340/* Double-check local_repo_env below if you add to this list. */
 341#define GIT_DIR_ENVIRONMENT "GIT_DIR"
 342#define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
 343#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
 344#define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
 345#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
 346#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
 347#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
 348#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
 349#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
 350#define CONFIG_ENVIRONMENT "GIT_CONFIG"
 351#define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
 352#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
 353#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
 354#define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
 355#define GITATTRIBUTES_FILE ".gitattributes"
 356#define INFOATTRIBUTES_FILE "info/attributes"
 357#define ATTRIBUTE_MACRO_PREFIX "[attr]"
 358#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
 359#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
 360#define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
 361#define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
 362#define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
 363#define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
 364
 365/*
 366 * This environment variable is expected to contain a boolean indicating
 367 * whether we should or should not treat:
 368 *
 369 *   GIT_DIR=foo.git git ...
 370 *
 371 * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
 372 * of this, but we use it internally to communicate to sub-processes that we
 373 * are in a bare repo. If not set, defaults to true.
 374 */
 375#define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
 376
 377/*
 378 * Repository-local GIT_* environment variables; these will be cleared
 379 * when git spawns a sub-process that runs inside another repository.
 380 * The array is NULL-terminated, which makes it easy to pass in the "env"
 381 * parameter of a run-command invocation, or to do a simple walk.
 382 */
 383extern const char * const local_repo_env[];
 384
 385extern int is_bare_repository_cfg;
 386extern int is_bare_repository(void);
 387extern int is_inside_git_dir(void);
 388extern char *git_work_tree_cfg;
 389extern int is_inside_work_tree(void);
 390extern int have_git_dir(void);
 391extern const char *get_git_dir(void);
 392extern int is_git_directory(const char *path);
 393extern char *get_object_directory(void);
 394extern char *get_index_file(void);
 395extern char *get_graft_file(void);
 396extern int set_git_dir(const char *path);
 397extern const char *get_git_namespace(void);
 398extern const char *strip_namespace(const char *namespaced_ref);
 399extern const char *get_git_work_tree(void);
 400extern const char *read_gitfile(const char *path);
 401extern const char *resolve_gitdir(const char *suspect);
 402extern void set_git_work_tree(const char *tree);
 403
 404#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
 405
 406extern const char **get_pathspec(const char *prefix, const char **pathspec);
 407extern void setup_work_tree(void);
 408extern const char *setup_git_directory_gently(int *);
 409extern const char *setup_git_directory(void);
 410extern char *prefix_path(const char *prefix, int len, const char *path);
 411extern const char *prefix_filename(const char *prefix, int len, const char *path);
 412extern int check_filename(const char *prefix, const char *name);
 413extern void verify_filename(const char *prefix,
 414                            const char *name,
 415                            int diagnose_misspelt_rev);
 416extern void verify_non_filename(const char *prefix, const char *name);
 417extern int path_inside_repo(const char *prefix, const char *path);
 418
 419#define INIT_DB_QUIET 0x0001
 420
 421extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
 422extern int init_db(const char *template_dir, unsigned int flags);
 423
 424#define alloc_nr(x) (((x)+16)*3/2)
 425
 426/*
 427 * Realloc the buffer pointed at by variable 'x' so that it can hold
 428 * at least 'nr' entries; the number of entries currently allocated
 429 * is 'alloc', using the standard growing factor alloc_nr() macro.
 430 *
 431 * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
 432 */
 433#define ALLOC_GROW(x, nr, alloc) \
 434        do { \
 435                if ((nr) > alloc) { \
 436                        if (alloc_nr(alloc) < (nr)) \
 437                                alloc = (nr); \
 438                        else \
 439                                alloc = alloc_nr(alloc); \
 440                        x = xrealloc((x), alloc * sizeof(*(x))); \
 441                } \
 442        } while (0)
 443
 444/* Initialize and use the cache information */
 445extern int read_index(struct index_state *);
 446extern int read_index_preload(struct index_state *, const char **pathspec);
 447extern int read_index_from(struct index_state *, const char *path);
 448extern int is_index_unborn(struct index_state *);
 449extern int read_index_unmerged(struct index_state *);
 450extern int write_index(struct index_state *, int newfd);
 451extern int discard_index(struct index_state *);
 452extern int unmerged_index(const struct index_state *);
 453extern int verify_path(const char *path);
 454extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
 455extern int index_name_pos(const struct index_state *, const char *name, int namelen);
 456#define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
 457#define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
 458#define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
 459#define ADD_CACHE_JUST_APPEND 8         /* Append only; tree.c::read_tree() */
 460#define ADD_CACHE_NEW_ONLY 16           /* Do not replace existing ones */
 461extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
 462extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
 463extern int remove_index_entry_at(struct index_state *, int pos);
 464extern void remove_marked_cache_entries(struct index_state *istate);
 465extern int remove_file_from_index(struct index_state *, const char *path);
 466#define ADD_CACHE_VERBOSE 1
 467#define ADD_CACHE_PRETEND 2
 468#define ADD_CACHE_IGNORE_ERRORS 4
 469#define ADD_CACHE_IGNORE_REMOVAL 8
 470#define ADD_CACHE_INTENT 16
 471#define ADD_CACHE_IMPLICIT_DOT 32       /* internal to "git add -u/-A" */
 472extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
 473extern int add_file_to_index(struct index_state *, const char *path, int flags);
 474extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
 475extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
 476extern int index_name_is_other(const struct index_state *, const char *, int);
 477extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
 478
 479/* do stat comparison even if CE_VALID is true */
 480#define CE_MATCH_IGNORE_VALID           01
 481/* do not check the contents but report dirty on racily-clean entries */
 482#define CE_MATCH_RACY_IS_DIRTY          02
 483/* do stat comparison even if CE_SKIP_WORKTREE is true */
 484#define CE_MATCH_IGNORE_SKIP_WORKTREE   04
 485extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
 486extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
 487
 488#define PATHSPEC_ONESTAR 1      /* the pathspec pattern sastisfies GFNM_ONESTAR */
 489
 490struct pathspec {
 491        const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
 492        int nr;
 493        unsigned int has_wildcard:1;
 494        unsigned int recursive:1;
 495        int max_depth;
 496        struct pathspec_item {
 497                const char *match;
 498                int len;
 499                int nowildcard_len;
 500                int flags;
 501        } *items;
 502};
 503
 504extern int init_pathspec(struct pathspec *, const char **);
 505extern void free_pathspec(struct pathspec *);
 506extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
 507
 508extern int limit_pathspec_to_literal(void);
 509
 510#define HASH_WRITE_OBJECT 1
 511#define HASH_FORMAT_CHECK 2
 512extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
 513extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
 514extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
 515
 516#define REFRESH_REALLY          0x0001  /* ignore_valid */
 517#define REFRESH_UNMERGED        0x0002  /* allow unmerged */
 518#define REFRESH_QUIET           0x0004  /* be quiet about it */
 519#define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
 520#define REFRESH_IGNORE_SUBMODULES       0x0010  /* ignore submodules */
 521#define REFRESH_IN_PORCELAIN    0x0020  /* user friendly output, not "needs update" */
 522extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, const char *header_msg);
 523
 524struct lock_file {
 525        struct lock_file *next;
 526        int fd;
 527        pid_t owner;
 528        char on_list;
 529        char filename[PATH_MAX];
 530};
 531#define LOCK_DIE_ON_ERROR 1
 532#define LOCK_NODEREF 2
 533extern int unable_to_lock_error(const char *path, int err);
 534extern NORETURN void unable_to_lock_index_die(const char *path, int err);
 535extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
 536extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
 537extern int commit_lock_file(struct lock_file *);
 538extern void update_index_if_able(struct index_state *, struct lock_file *);
 539
 540extern int hold_locked_index(struct lock_file *, int);
 541extern int commit_locked_index(struct lock_file *);
 542extern void set_alternate_index_output(const char *);
 543extern int close_lock_file(struct lock_file *);
 544extern void rollback_lock_file(struct lock_file *);
 545extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
 546
 547/* Environment bits from configuration mechanism */
 548extern int trust_executable_bit;
 549extern int trust_ctime;
 550extern int check_stat;
 551extern int quote_path_fully;
 552extern int has_symlinks;
 553extern int minimum_abbrev, default_abbrev;
 554extern int ignore_case;
 555extern int assume_unchanged;
 556extern int prefer_symlink_refs;
 557extern int log_all_ref_updates;
 558extern int warn_ambiguous_refs;
 559extern int shared_repository;
 560extern const char *apply_default_whitespace;
 561extern const char *apply_default_ignorewhitespace;
 562extern const char *git_attributes_file;
 563extern int zlib_compression_level;
 564extern int core_compression_level;
 565extern int core_compression_seen;
 566extern size_t packed_git_window_size;
 567extern size_t packed_git_limit;
 568extern size_t delta_base_cache_limit;
 569extern unsigned long big_file_threshold;
 570extern unsigned long pack_size_limit_cfg;
 571extern int read_replace_refs;
 572extern int fsync_object_files;
 573extern int core_preload_index;
 574extern int core_apply_sparse_checkout;
 575extern int precomposed_unicode;
 576
 577/*
 578 * The character that begins a commented line in user-editable file
 579 * that is subject to stripspace.
 580 */
 581extern char comment_line_char;
 582
 583enum branch_track {
 584        BRANCH_TRACK_UNSPECIFIED = -1,
 585        BRANCH_TRACK_NEVER = 0,
 586        BRANCH_TRACK_REMOTE,
 587        BRANCH_TRACK_ALWAYS,
 588        BRANCH_TRACK_EXPLICIT,
 589        BRANCH_TRACK_OVERRIDE
 590};
 591
 592enum rebase_setup_type {
 593        AUTOREBASE_NEVER = 0,
 594        AUTOREBASE_LOCAL,
 595        AUTOREBASE_REMOTE,
 596        AUTOREBASE_ALWAYS
 597};
 598
 599enum push_default_type {
 600        PUSH_DEFAULT_NOTHING = 0,
 601        PUSH_DEFAULT_MATCHING,
 602        PUSH_DEFAULT_SIMPLE,
 603        PUSH_DEFAULT_UPSTREAM,
 604        PUSH_DEFAULT_CURRENT,
 605        PUSH_DEFAULT_UNSPECIFIED
 606};
 607
 608extern enum branch_track git_branch_track;
 609extern enum rebase_setup_type autorebase;
 610extern enum push_default_type push_default;
 611
 612enum object_creation_mode {
 613        OBJECT_CREATION_USES_HARDLINKS = 0,
 614        OBJECT_CREATION_USES_RENAMES = 1
 615};
 616
 617extern enum object_creation_mode object_creation_mode;
 618
 619extern char *notes_ref_name;
 620
 621extern int grafts_replace_parents;
 622
 623#define GIT_REPO_VERSION 0
 624extern int repository_format_version;
 625extern int check_repository_format(void);
 626
 627#define MTIME_CHANGED   0x0001
 628#define CTIME_CHANGED   0x0002
 629#define OWNER_CHANGED   0x0004
 630#define MODE_CHANGED    0x0008
 631#define INODE_CHANGED   0x0010
 632#define DATA_CHANGED    0x0020
 633#define TYPE_CHANGED    0x0040
 634
 635extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
 636        __attribute__((format (printf, 3, 4)));
 637extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
 638        __attribute__((format (printf, 3, 4)));
 639extern char *git_pathdup(const char *fmt, ...)
 640        __attribute__((format (printf, 1, 2)));
 641extern char *mkpathdup(const char *fmt, ...)
 642        __attribute__((format (printf, 1, 2)));
 643
 644/* Return a statically allocated filename matching the sha1 signature */
 645extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 646extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 647extern char *git_path_submodule(const char *path, const char *fmt, ...)
 648        __attribute__((format (printf, 2, 3)));
 649
 650extern char *sha1_file_name(const unsigned char *sha1);
 651extern char *sha1_pack_name(const unsigned char *sha1);
 652extern char *sha1_pack_index_name(const unsigned char *sha1);
 653extern const char *find_unique_abbrev(const unsigned char *sha1, int);
 654extern const unsigned char null_sha1[20];
 655
 656static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
 657{
 658        int i;
 659
 660        for (i = 0; i < 20; i++, sha1++, sha2++) {
 661                if (*sha1 != *sha2)
 662                        return *sha1 - *sha2;
 663        }
 664
 665        return 0;
 666}
 667
 668static inline int is_null_sha1(const unsigned char *sha1)
 669{
 670        return !hashcmp(sha1, null_sha1);
 671}
 672
 673static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
 674{
 675        memcpy(sha_dst, sha_src, 20);
 676}
 677static inline void hashclr(unsigned char *hash)
 678{
 679        memset(hash, 0, 20);
 680}
 681
 682#define EMPTY_TREE_SHA1_HEX \
 683        "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
 684#define EMPTY_TREE_SHA1_BIN_LITERAL \
 685         "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
 686         "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
 687#define EMPTY_TREE_SHA1_BIN \
 688         ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
 689
 690#define EMPTY_BLOB_SHA1_HEX \
 691        "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
 692#define EMPTY_BLOB_SHA1_BIN_LITERAL \
 693        "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
 694        "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
 695#define EMPTY_BLOB_SHA1_BIN \
 696        ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
 697
 698static inline int is_empty_blob_sha1(const unsigned char *sha1)
 699{
 700        return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
 701}
 702
 703int git_mkstemp(char *path, size_t n, const char *template);
 704
 705int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
 706
 707/* set default permissions by passing mode arguments to open(2) */
 708int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
 709int git_mkstemp_mode(char *pattern, int mode);
 710
 711/*
 712 * NOTE NOTE NOTE!!
 713 *
 714 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
 715 * not be changed. Old repositories have core.sharedrepository written in
 716 * numeric format, and therefore these values are preserved for compatibility
 717 * reasons.
 718 */
 719enum sharedrepo {
 720        PERM_UMASK          = 0,
 721        OLD_PERM_GROUP      = 1,
 722        OLD_PERM_EVERYBODY  = 2,
 723        PERM_GROUP          = 0660,
 724        PERM_EVERYBODY      = 0664
 725};
 726int git_config_perm(const char *var, const char *value);
 727int adjust_shared_perm(const char *path);
 728int safe_create_leading_directories(char *path);
 729int safe_create_leading_directories_const(const char *path);
 730int mkdir_in_gitdir(const char *path);
 731extern void home_config_paths(char **global, char **xdg, char *file);
 732extern char *expand_user_path(const char *path);
 733const char *enter_repo(const char *path, int strict);
 734static inline int is_absolute_path(const char *path)
 735{
 736        return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
 737}
 738int is_directory(const char *);
 739const char *real_path(const char *path);
 740const char *real_path_if_valid(const char *path);
 741const char *absolute_path(const char *path);
 742const char *relative_path(const char *abs, const char *base);
 743int normalize_path_copy(char *dst, const char *src);
 744int longest_ancestor_length(const char *path, struct string_list *prefixes);
 745char *strip_path_suffix(const char *path, const char *suffix);
 746int daemon_avoid_alias(const char *path);
 747int offset_1st_component(const char *path);
 748
 749/* object replacement */
 750#define READ_SHA1_FILE_REPLACE 1
 751extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
 752static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
 753{
 754        return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
 755}
 756extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
 757static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
 758{
 759        if (!read_replace_refs)
 760                return sha1;
 761        return do_lookup_replace_object(sha1);
 762}
 763
 764/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
 765extern int sha1_object_info(const unsigned char *, unsigned long *);
 766extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
 767extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
 768extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
 769extern int force_object_loose(const unsigned char *sha1, time_t mtime);
 770extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
 771extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
 772extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
 773
 774/* global flag to enable extra checks when accessing packed objects */
 775extern int do_check_packed_object_crc;
 776
 777extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
 778
 779extern int move_temp_to_file(const char *tmpfile, const char *filename);
 780
 781extern int has_sha1_pack(const unsigned char *sha1);
 782extern int has_sha1_file(const unsigned char *sha1);
 783extern int has_loose_object_nonlocal(const unsigned char *sha1);
 784
 785extern int has_pack_index(const unsigned char *sha1);
 786
 787extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
 788
 789extern const signed char hexval_table[256];
 790static inline unsigned int hexval(unsigned char c)
 791{
 792        return hexval_table[c];
 793}
 794
 795/* Convert to/from hex/sha1 representation */
 796#define MINIMUM_ABBREV minimum_abbrev
 797#define DEFAULT_ABBREV default_abbrev
 798
 799struct object_context {
 800        unsigned char tree[20];
 801        char path[PATH_MAX];
 802        unsigned mode;
 803};
 804
 805#define GET_SHA1_QUIETLY        01
 806#define GET_SHA1_COMMIT         02
 807#define GET_SHA1_COMMITTISH     04
 808#define GET_SHA1_TREE          010
 809#define GET_SHA1_TREEISH       020
 810#define GET_SHA1_BLOB          040
 811#define GET_SHA1_ONLY_TO_DIE 04000
 812
 813extern int get_sha1(const char *str, unsigned char *sha1);
 814extern int get_sha1_commit(const char *str, unsigned char *sha1);
 815extern int get_sha1_committish(const char *str, unsigned char *sha1);
 816extern int get_sha1_tree(const char *str, unsigned char *sha1);
 817extern int get_sha1_treeish(const char *str, unsigned char *sha1);
 818extern int get_sha1_blob(const char *str, unsigned char *sha1);
 819extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
 820extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
 821
 822typedef int each_abbrev_fn(const unsigned char *sha1, void *);
 823extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
 824
 825/*
 826 * Try to read a SHA1 in hexadecimal format from the 40 characters
 827 * starting at hex.  Write the 20-byte result to sha1 in binary form.
 828 * Return 0 on success.  Reading stops if a NUL is encountered in the
 829 * input, so it is safe to pass this function an arbitrary
 830 * null-terminated string.
 831 */
 832extern int get_sha1_hex(const char *hex, unsigned char *sha1);
 833
 834extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
 835extern int read_ref_full(const char *refname, unsigned char *sha1,
 836                         int reading, int *flags);
 837extern int read_ref(const char *refname, unsigned char *sha1);
 838
 839/*
 840 * Resolve a reference, recursively following symbolic refererences.
 841 *
 842 * Store the referred-to object's name in sha1 and return the name of
 843 * the non-symbolic reference that ultimately pointed at it.  The
 844 * return value, if not NULL, is a pointer into either a static buffer
 845 * or the input ref.
 846 *
 847 * If the reference cannot be resolved to an object, the behavior
 848 * depends on the "reading" argument:
 849 *
 850 * - If reading is set, return NULL.
 851 *
 852 * - If reading is not set, clear sha1 and return the name of the last
 853 *   reference name in the chain, which will either be a non-symbolic
 854 *   reference or an undefined reference.  If this is a prelude to
 855 *   "writing" to the ref, the return value is the name of the ref
 856 *   that will actually be created or changed.
 857 *
 858 * If flag is non-NULL, set the value that it points to the
 859 * combination of REF_ISPACKED (if the reference was found among the
 860 * packed references) and REF_ISSYMREF (if the initial reference was a
 861 * symbolic reference).
 862 *
 863 * If ref is not a properly-formatted, normalized reference, return
 864 * NULL.  If more than MAXDEPTH recursive symbolic lookups are needed,
 865 * give up and return NULL.
 866 *
 867 * errno is sometimes set on errors, but not always.
 868 */
 869extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
 870extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
 871
 872extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
 873extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
 874extern int interpret_branch_name(const char *str, struct strbuf *);
 875extern int get_sha1_mb(const char *str, unsigned char *sha1);
 876
 877extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
 878extern const char *ref_rev_parse_rules[];
 879#define ref_fetch_rules ref_rev_parse_rules
 880
 881extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
 882extern int validate_headref(const char *ref);
 883
 884extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
 885extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
 886extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
 887extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
 888
 889extern void *read_object_with_reference(const unsigned char *sha1,
 890                                        const char *required_type,
 891                                        unsigned long *size,
 892                                        unsigned char *sha1_ret);
 893
 894extern struct object *peel_to_type(const char *name, int namelen,
 895                                   struct object *o, enum object_type);
 896
 897enum date_mode {
 898        DATE_NORMAL = 0,
 899        DATE_RELATIVE,
 900        DATE_SHORT,
 901        DATE_LOCAL,
 902        DATE_ISO8601,
 903        DATE_RFC2822,
 904        DATE_RAW
 905};
 906
 907const char *show_date(unsigned long time, int timezone, enum date_mode mode);
 908void show_date_relative(unsigned long time, int tz, const struct timeval *now,
 909                        struct strbuf *timebuf);
 910int parse_date(const char *date, char *buf, int bufsize);
 911int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
 912int parse_expiry_date(const char *date, unsigned long *timestamp);
 913void datestamp(char *buf, int bufsize);
 914#define approxidate(s) approxidate_careful((s), NULL)
 915unsigned long approxidate_careful(const char *, int *);
 916unsigned long approxidate_relative(const char *date, const struct timeval *now);
 917enum date_mode parse_date_format(const char *format);
 918
 919#define IDENT_STRICT           1
 920#define IDENT_NO_DATE          2
 921#define IDENT_NO_NAME          4
 922extern const char *git_author_info(int);
 923extern const char *git_committer_info(int);
 924extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
 925extern const char *fmt_name(const char *name, const char *email);
 926extern const char *ident_default_email(void);
 927extern const char *git_editor(void);
 928extern const char *git_pager(int stdout_is_tty);
 929extern int git_ident_config(const char *, const char *, void *);
 930
 931struct ident_split {
 932        const char *name_begin;
 933        const char *name_end;
 934        const char *mail_begin;
 935        const char *mail_end;
 936        const char *date_begin;
 937        const char *date_end;
 938        const char *tz_begin;
 939        const char *tz_end;
 940};
 941/*
 942 * Signals an success with 0, but time part of the result may be NULL
 943 * if the input lacks timestamp and zone
 944 */
 945extern int split_ident_line(struct ident_split *, const char *, int);
 946
 947struct checkout {
 948        const char *base_dir;
 949        int base_dir_len;
 950        unsigned force:1,
 951                 quiet:1,
 952                 not_new:1,
 953                 refresh_cache:1;
 954};
 955
 956extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
 957
 958struct cache_def {
 959        char path[PATH_MAX + 1];
 960        int len;
 961        int flags;
 962        int track_flags;
 963        int prefix_len_stat_func;
 964};
 965
 966extern int has_symlink_leading_path(const char *name, int len);
 967extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
 968extern int check_leading_path(const char *name, int len);
 969extern int has_dirs_only_path(const char *name, int len, int prefix_len);
 970extern void schedule_dir_for_removal(const char *name, int len);
 971extern void remove_scheduled_dirs(void);
 972
 973extern struct alternate_object_database {
 974        struct alternate_object_database *next;
 975        char *name;
 976        char base[FLEX_ARRAY]; /* more */
 977} *alt_odb_list;
 978extern void prepare_alt_odb(void);
 979extern void read_info_alternates(const char * relative_base, int depth);
 980extern void add_to_alternates_file(const char *reference);
 981typedef int alt_odb_fn(struct alternate_object_database *, void *);
 982extern void foreach_alt_odb(alt_odb_fn, void*);
 983
 984struct pack_window {
 985        struct pack_window *next;
 986        unsigned char *base;
 987        off_t offset;
 988        size_t len;
 989        unsigned int last_used;
 990        unsigned int inuse_cnt;
 991};
 992
 993extern struct packed_git {
 994        struct packed_git *next;
 995        struct pack_window *windows;
 996        off_t pack_size;
 997        const void *index_data;
 998        size_t index_size;
 999        uint32_t num_objects;
1000        uint32_t num_bad_objects;
1001        unsigned char *bad_object_sha1;
1002        int index_version;
1003        time_t mtime;
1004        int pack_fd;
1005        unsigned pack_local:1,
1006                 pack_keep:1,
1007                 do_not_close:1;
1008        unsigned char sha1[20];
1009        /* something like ".git/objects/pack/xxxxx.pack" */
1010        char pack_name[FLEX_ARRAY]; /* more */
1011} *packed_git;
1012
1013struct pack_entry {
1014        off_t offset;
1015        unsigned char sha1[20];
1016        struct packed_git *p;
1017};
1018
1019struct ref {
1020        struct ref *next;
1021        unsigned char old_sha1[20];
1022        unsigned char new_sha1[20];
1023        char *symref;
1024        unsigned int
1025                force:1,
1026                forced_update:1,
1027                deletion:1,
1028                matched:1;
1029
1030        /*
1031         * Order is important here, as we write to FETCH_HEAD
1032         * in numeric order. And the default NOT_FOR_MERGE
1033         * should be 0, so that xcalloc'd structures get it
1034         * by default.
1035         */
1036        enum {
1037                FETCH_HEAD_MERGE = -1,
1038                FETCH_HEAD_NOT_FOR_MERGE = 0,
1039                FETCH_HEAD_IGNORE = 1
1040        } fetch_head_status;
1041
1042        enum {
1043                REF_STATUS_NONE = 0,
1044                REF_STATUS_OK,
1045                REF_STATUS_REJECT_NONFASTFORWARD,
1046                REF_STATUS_REJECT_ALREADY_EXISTS,
1047                REF_STATUS_REJECT_NODELETE,
1048                REF_STATUS_REJECT_FETCH_FIRST,
1049                REF_STATUS_REJECT_NEEDS_FORCE,
1050                REF_STATUS_UPTODATE,
1051                REF_STATUS_REMOTE_REJECT,
1052                REF_STATUS_EXPECTING_REPORT
1053        } status;
1054        char *remote_status;
1055        struct ref *peer_ref; /* when renaming */
1056        char name[FLEX_ARRAY]; /* more */
1057};
1058
1059#define REF_NORMAL      (1u << 0)
1060#define REF_HEADS       (1u << 1)
1061#define REF_TAGS        (1u << 2)
1062
1063extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
1064
1065#define CONNECT_VERBOSE       (1u << 0)
1066extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
1067extern int finish_connect(struct child_process *conn);
1068extern int git_connection_is_socket(struct child_process *conn);
1069struct extra_have_objects {
1070        int nr, alloc;
1071        unsigned char (*array)[20];
1072};
1073extern struct ref **get_remote_heads(int in, char *src_buf, size_t src_len,
1074                                     struct ref **list, unsigned int flags,
1075                                     struct extra_have_objects *);
1076extern int server_supports(const char *feature);
1077extern int parse_feature_request(const char *features, const char *feature);
1078extern const char *server_feature_value(const char *feature, int *len_ret);
1079extern const char *parse_feature_value(const char *feature_list, const char *feature, int *len_ret);
1080
1081extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1082
1083/* A hook for count-objects to report invalid files in pack directory */
1084extern void (*report_garbage)(const char *desc, const char *path);
1085
1086extern void prepare_packed_git(void);
1087extern void reprepare_packed_git(void);
1088extern void install_packed_git(struct packed_git *pack);
1089
1090extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1091                                         struct packed_git *packs);
1092
1093extern void pack_report(void);
1094extern int open_pack_index(struct packed_git *);
1095extern void close_pack_index(struct packed_git *);
1096extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1097extern void close_pack_windows(struct packed_git *);
1098extern void unuse_pack(struct pack_window **);
1099extern void free_pack_by_name(const char *);
1100extern void clear_delta_base_cache(void);
1101extern struct packed_git *add_packed_git(const char *, int, int);
1102extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
1103extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
1104extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
1105extern int is_pack_valid(struct packed_git *);
1106extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1107extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1108extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1109extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1110
1111struct object_info {
1112        /* Request */
1113        unsigned long *sizep;
1114
1115        /* Response */
1116        enum {
1117                OI_CACHED,
1118                OI_LOOSE,
1119                OI_PACKED,
1120                OI_DBCACHED
1121        } whence;
1122        union {
1123                /*
1124                 * struct {
1125                 *      ... Nothing to expose in this case
1126                 * } cached;
1127                 * struct {
1128                 *      ... Nothing to expose in this case
1129                 * } loose;
1130                 */
1131                struct {
1132                        struct packed_git *pack;
1133                        off_t offset;
1134                        unsigned int is_delta;
1135                } packed;
1136        } u;
1137};
1138extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
1139
1140/* Dumb servers support */
1141extern int update_server_info(int);
1142
1143/* git_config_parse_key() returns these negated: */
1144#define CONFIG_INVALID_KEY 1
1145#define CONFIG_NO_SECTION_OR_NAME 2
1146/* git_config_set(), git_config_set_multivar() return the above or these: */
1147#define CONFIG_NO_LOCK -1
1148#define CONFIG_INVALID_FILE 3
1149#define CONFIG_NO_WRITE 4
1150#define CONFIG_NOTHING_SET 5
1151#define CONFIG_INVALID_PATTERN 6
1152#define CONFIG_GENERIC_ERROR 7
1153
1154typedef int (*config_fn_t)(const char *, const char *, void *);
1155extern int git_default_config(const char *, const char *, void *);
1156extern int git_config_from_file(config_fn_t fn, const char *, void *);
1157extern void git_config_push_parameter(const char *text);
1158extern int git_config_from_parameters(config_fn_t fn, void *data);
1159extern int git_config(config_fn_t fn, void *);
1160extern int git_config_with_options(config_fn_t fn, void *,
1161                                   const char *filename, int respect_includes);
1162extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1163extern int git_parse_ulong(const char *, unsigned long *);
1164extern int git_config_int(const char *, const char *);
1165extern unsigned long git_config_ulong(const char *, const char *);
1166extern int git_config_bool_or_int(const char *, const char *, int *);
1167extern int git_config_bool(const char *, const char *);
1168extern int git_config_maybe_bool(const char *, const char *);
1169extern int git_config_string(const char **, const char *, const char *);
1170extern int git_config_pathname(const char **, const char *, const char *);
1171extern int git_config_set_in_file(const char *, const char *, const char *);
1172extern int git_config_set(const char *, const char *);
1173extern int git_config_parse_key(const char *, char **, int *);
1174extern int git_config_set_multivar(const char *, const char *, const char *, int);
1175extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1176extern int git_config_rename_section(const char *, const char *);
1177extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1178extern const char *git_etc_gitconfig(void);
1179extern int check_repository_format_version(const char *var, const char *value, void *cb);
1180extern int git_env_bool(const char *, int);
1181extern int git_config_system(void);
1182extern int config_error_nonbool(const char *);
1183#if defined(__GNUC__) && ! defined(__clang__)
1184#define config_error_nonbool(s) (config_error_nonbool(s), -1)
1185#endif
1186extern const char *get_log_output_encoding(void);
1187extern const char *get_commit_output_encoding(void);
1188
1189extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1190
1191struct config_include_data {
1192        int depth;
1193        config_fn_t fn;
1194        void *data;
1195};
1196#define CONFIG_INCLUDE_INIT { 0 }
1197extern int git_config_include(const char *name, const char *value, void *data);
1198
1199/*
1200 * Match and parse a config key of the form:
1201 *
1202 *   section.(subsection.)?key
1203 *
1204 * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1205 * we return -1 if it does not match, 0 otherwise. The subsection and key
1206 * out-parameters are filled by the function (and subsection is NULL if it is
1207 * missing).
1208 */
1209extern int parse_config_key(const char *var,
1210                            const char *section,
1211                            const char **subsection, int *subsection_len,
1212                            const char **key);
1213
1214extern int committer_ident_sufficiently_given(void);
1215extern int author_ident_sufficiently_given(void);
1216
1217extern const char *git_commit_encoding;
1218extern const char *git_log_output_encoding;
1219extern const char *git_mailmap_file;
1220extern const char *git_mailmap_blob;
1221
1222/* IO helper functions */
1223extern void maybe_flush_or_die(FILE *, const char *);
1224extern int copy_fd(int ifd, int ofd);
1225extern int copy_file(const char *dst, const char *src, int mode);
1226extern int copy_file_with_time(const char *dst, const char *src, int mode);
1227extern void write_or_die(int fd, const void *buf, size_t count);
1228extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1229extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1230extern void fsync_or_die(int fd, const char *);
1231
1232extern ssize_t read_in_full(int fd, void *buf, size_t count);
1233extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1234static inline ssize_t write_str_in_full(int fd, const char *str)
1235{
1236        return write_in_full(fd, str, strlen(str));
1237}
1238
1239/* pager.c */
1240extern void setup_pager(void);
1241extern const char *pager_program;
1242extern int pager_in_use(void);
1243extern int pager_use_color;
1244extern int term_columns(void);
1245extern int decimal_width(int);
1246extern int check_pager_config(const char *cmd);
1247
1248extern const char *editor_program;
1249extern const char *askpass_program;
1250extern const char *excludes_file;
1251
1252/* base85 */
1253int decode_85(char *dst, const char *line, int linelen);
1254void encode_85(char *buf, const unsigned char *data, int bytes);
1255
1256/* alloc.c */
1257extern void *alloc_blob_node(void);
1258extern void *alloc_tree_node(void);
1259extern void *alloc_commit_node(void);
1260extern void *alloc_tag_node(void);
1261extern void *alloc_object_node(void);
1262extern void alloc_report(void);
1263
1264/* trace.c */
1265__attribute__((format (printf, 1, 2)))
1266extern void trace_printf(const char *format, ...);
1267__attribute__((format (printf, 2, 3)))
1268extern void trace_argv_printf(const char **argv, const char *format, ...);
1269extern void trace_repo_setup(const char *prefix);
1270extern int trace_want(const char *key);
1271extern void trace_strbuf(const char *key, const struct strbuf *buf);
1272
1273void packet_trace_identity(const char *prog);
1274
1275/* add */
1276/*
1277 * return 0 if success, 1 - if addition of a file failed and
1278 * ADD_FILES_IGNORE_ERRORS was specified in flags
1279 */
1280int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1281
1282/* diff.c */
1283extern int diff_auto_refresh_index;
1284
1285/* match-trees.c */
1286void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1287void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1288
1289/*
1290 * whitespace rules.
1291 * used by both diff and apply
1292 * last two digits are tab width
1293 */
1294#define WS_BLANK_AT_EOL         0100
1295#define WS_SPACE_BEFORE_TAB     0200
1296#define WS_INDENT_WITH_NON_TAB  0400
1297#define WS_CR_AT_EOL           01000
1298#define WS_BLANK_AT_EOF        02000
1299#define WS_TAB_IN_INDENT       04000
1300#define WS_TRAILING_SPACE      (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1301#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1302#define WS_TAB_WIDTH_MASK        077
1303extern unsigned whitespace_rule_cfg;
1304extern unsigned whitespace_rule(const char *);
1305extern unsigned parse_whitespace_rule(const char *);
1306extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1307extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1308extern char *whitespace_error_string(unsigned ws);
1309extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1310extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1311#define ws_tab_width(rule)     ((rule) & WS_TAB_WIDTH_MASK)
1312
1313/* ls-files */
1314int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix);
1315void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1316
1317char *alias_lookup(const char *alias);
1318int split_cmdline(char *cmdline, const char ***argv);
1319/* Takes a negative value returned by split_cmdline */
1320const char *split_cmdline_strerror(int cmdline_errno);
1321
1322/* git.c */
1323struct startup_info {
1324        int have_repository;
1325        const char *prefix;
1326};
1327extern struct startup_info *startup_info;
1328
1329/* merge.c */
1330struct commit_list;
1331int try_merge_command(const char *strategy, size_t xopts_nr,
1332                const char **xopts, struct commit_list *common,
1333                const char *head_arg, struct commit_list *remotes);
1334int checkout_fast_forward(const unsigned char *from,
1335                          const unsigned char *to,
1336                          int overwrite_ignore);
1337
1338
1339int sane_execvp(const char *file, char *const argv[]);
1340
1341#endif /* CACHE_H */