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