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