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