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