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