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