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