Andrew's git - gitweb.git/blob

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