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