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
 156static inline unsigned create_ce_flags(size_t len, unsigned stage)
 157{
 158        if (len >= CE_NAMEMASK)
 159                len = CE_NAMEMASK;
 160        return (len | (stage << CE_STAGESHIFT));
 161}
 162
 163static inline size_t ce_namelen(const struct cache_entry *ce)
 164{
 165        size_t len = ce->ce_flags & CE_NAMEMASK;
 166        if (len < CE_NAMEMASK)
 167                return len;
 168        return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
 169}
 170
 171#define ce_size(ce) cache_entry_size(ce_namelen(ce))
 172#define ondisk_ce_size(ce) ondisk_cache_entry_size(ce_namelen(ce))
 173#define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
 174#define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
 175#define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
 176
 177#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
 178static inline unsigned int create_ce_mode(unsigned int mode)
 179{
 180        if (S_ISLNK(mode))
 181                return S_IFLNK;
 182        if (S_ISDIR(mode) || S_ISGITLINK(mode))
 183                return S_IFGITLINK;
 184        return S_IFREG | ce_permissions(mode);
 185}
 186static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
 187{
 188        extern int trust_executable_bit, has_symlinks;
 189        if (!has_symlinks && S_ISREG(mode) &&
 190            ce && S_ISLNK(ce->ce_mode))
 191                return ce->ce_mode;
 192        if (!trust_executable_bit && S_ISREG(mode)) {
 193                if (ce && S_ISREG(ce->ce_mode))
 194                        return ce->ce_mode;
 195                return create_ce_mode(0666);
 196        }
 197        return create_ce_mode(mode);
 198}
 199static inline int ce_to_dtype(const struct cache_entry *ce)
 200{
 201        unsigned ce_mode = ntohl(ce->ce_mode);
 202        if (S_ISREG(ce_mode))
 203                return DT_REG;
 204        else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
 205                return DT_DIR;
 206        else if (S_ISLNK(ce_mode))
 207                return DT_LNK;
 208        else
 209                return DT_UNKNOWN;
 210}
 211#define canon_mode(mode) \
 212        (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
 213        S_ISLNK(mode) ? S_IFLNK : S_ISDIR(mode) ? S_IFDIR : S_IFGITLINK)
 214
 215#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
 216#define ondisk_cache_entry_size(len) ((offsetof(struct ondisk_cache_entry,name) + (len) + 8) & ~7)
 217
 218struct index_state {
 219        struct cache_entry **cache;
 220        unsigned int cache_nr, cache_alloc, cache_changed;
 221        struct cache_tree *cache_tree;
 222        time_t timestamp;
 223        void *alloc;
 224        unsigned name_hash_initialized : 1;
 225        struct hash_table name_hash;
 226};
 227
 228extern struct index_state the_index;
 229
 230/* Name hashing */
 231extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
 232/*
 233 * We don't actually *remove* it, we can just mark it invalid so that
 234 * we won't find it in lookups.
 235 *
 236 * Not only would we have to search the lists (simple enough), but
 237 * we'd also have to rehash other hash buckets in case this makes the
 238 * hash bucket empty (common). So it's much better to just mark
 239 * it.
 240 */
 241static inline void remove_name_hash(struct cache_entry *ce)
 242{
 243        ce->ce_flags |= CE_UNHASHED;
 244}
 245
 246
 247#ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
 248#define active_cache (the_index.cache)
 249#define active_nr (the_index.cache_nr)
 250#define active_alloc (the_index.cache_alloc)
 251#define active_cache_changed (the_index.cache_changed)
 252#define active_cache_tree (the_index.cache_tree)
 253
 254#define read_cache() read_index(&the_index)
 255#define read_cache_from(path) read_index_from(&the_index, (path))
 256#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
 257#define discard_cache() discard_index(&the_index)
 258#define unmerged_cache() unmerged_index(&the_index)
 259#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
 260#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
 261#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
 262#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
 263#define add_file_to_cache(path, verbose) add_file_to_index(&the_index, (path), (verbose))
 264#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL)
 265#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
 266#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
 267#define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
 268#endif
 269
 270enum object_type {
 271        OBJ_BAD = -1,
 272        OBJ_NONE = 0,
 273        OBJ_COMMIT = 1,
 274        OBJ_TREE = 2,
 275        OBJ_BLOB = 3,
 276        OBJ_TAG = 4,
 277        /* 5 for future expansion */
 278        OBJ_OFS_DELTA = 6,
 279        OBJ_REF_DELTA = 7,
 280        OBJ_ANY,
 281        OBJ_MAX,
 282};
 283
 284static inline enum object_type object_type(unsigned int mode)
 285{
 286        return S_ISDIR(mode) ? OBJ_TREE :
 287                S_ISGITLINK(mode) ? OBJ_COMMIT :
 288                OBJ_BLOB;
 289}
 290
 291#define GIT_DIR_ENVIRONMENT "GIT_DIR"
 292#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
 293#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
 294#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
 295#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
 296#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
 297#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
 298#define CONFIG_ENVIRONMENT "GIT_CONFIG"
 299#define CONFIG_LOCAL_ENVIRONMENT "GIT_CONFIG_LOCAL"
 300#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
 301#define GITATTRIBUTES_FILE ".gitattributes"
 302#define INFOATTRIBUTES_FILE "info/attributes"
 303#define ATTRIBUTE_MACRO_PREFIX "[attr]"
 304
 305extern int is_bare_repository_cfg;
 306extern int is_bare_repository(void);
 307extern int is_inside_git_dir(void);
 308extern char *git_work_tree_cfg;
 309extern int is_inside_work_tree(void);
 310extern const char *get_git_dir(void);
 311extern char *get_object_directory(void);
 312extern char *get_refs_directory(void);
 313extern char *get_index_file(void);
 314extern char *get_graft_file(void);
 315extern int set_git_dir(const char *path);
 316extern const char *get_git_work_tree(void);
 317
 318#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
 319
 320extern const char **get_pathspec(const char *prefix, const char **pathspec);
 321extern void setup_work_tree(void);
 322extern const char *setup_git_directory_gently(int *);
 323extern const char *setup_git_directory(void);
 324extern const char *prefix_path(const char *prefix, int len, const char *path);
 325extern const char *prefix_filename(const char *prefix, int len, const char *path);
 326extern void verify_filename(const char *prefix, const char *name);
 327extern void verify_non_filename(const char *prefix, const char *name);
 328
 329#define alloc_nr(x) (((x)+16)*3/2)
 330
 331/*
 332 * Realloc the buffer pointed at by variable 'x' so that it can hold
 333 * at least 'nr' entries; the number of entries currently allocated
 334 * is 'alloc', using the standard growing factor alloc_nr() macro.
 335 *
 336 * DO NOT USE any expression with side-effect for 'x' or 'alloc'.
 337 */
 338#define ALLOC_GROW(x, nr, alloc) \
 339        do { \
 340                if ((nr) > alloc) { \
 341                        if (alloc_nr(alloc) < (nr)) \
 342                                alloc = (nr); \
 343                        else \
 344                                alloc = alloc_nr(alloc); \
 345                        x = xrealloc((x), alloc * sizeof(*(x))); \
 346                } \
 347        } while(0)
 348
 349/* Initialize and use the cache information */
 350extern int read_index(struct index_state *);
 351extern int read_index_from(struct index_state *, const char *path);
 352extern int write_index(const struct index_state *, int newfd);
 353extern int discard_index(struct index_state *);
 354extern int unmerged_index(const struct index_state *);
 355extern int verify_path(const char *path);
 356extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
 357extern int index_name_pos(const struct index_state *, const char *name, int namelen);
 358#define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
 359#define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
 360#define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
 361#define ADD_CACHE_JUST_APPEND 8         /* Append only; tree.c::read_tree() */
 362extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
 363extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
 364extern int remove_index_entry_at(struct index_state *, int pos);
 365extern int remove_file_from_index(struct index_state *, const char *path);
 366extern int add_file_to_index(struct index_state *, const char *path, int verbose);
 367extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
 368extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
 369
 370/* do stat comparison even if CE_VALID is true */
 371#define CE_MATCH_IGNORE_VALID           01
 372/* do not check the contents but report dirty on racily-clean entries */
 373#define CE_MATCH_RACY_IS_DIRTY  02
 374extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
 375extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
 376
 377extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
 378extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
 379extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
 380extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
 381extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
 382
 383#define REFRESH_REALLY          0x0001  /* ignore_valid */
 384#define REFRESH_UNMERGED        0x0002  /* allow unmerged */
 385#define REFRESH_QUIET           0x0004  /* be quiet about it */
 386#define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
 387extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen);
 388
 389struct lock_file {
 390        struct lock_file *next;
 391        int fd;
 392        pid_t owner;
 393        char on_list;
 394        char filename[PATH_MAX];
 395};
 396extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
 397extern int commit_lock_file(struct lock_file *);
 398
 399extern int hold_locked_index(struct lock_file *, int);
 400extern int commit_locked_index(struct lock_file *);
 401extern void set_alternate_index_output(const char *);
 402extern int close_lock_file(struct lock_file *);
 403extern void rollback_lock_file(struct lock_file *);
 404extern int delete_ref(const char *, const unsigned char *sha1);
 405
 406/* Environment bits from configuration mechanism */
 407extern int trust_executable_bit;
 408extern int quote_path_fully;
 409extern int has_symlinks;
 410extern int ignore_case;
 411extern int assume_unchanged;
 412extern int prefer_symlink_refs;
 413extern int log_all_ref_updates;
 414extern int warn_ambiguous_refs;
 415extern int shared_repository;
 416extern const char *apply_default_whitespace;
 417extern int zlib_compression_level;
 418extern int core_compression_level;
 419extern int core_compression_seen;
 420extern size_t packed_git_window_size;
 421extern size_t packed_git_limit;
 422extern size_t delta_base_cache_limit;
 423extern int auto_crlf;
 424
 425enum safe_crlf {
 426        SAFE_CRLF_FALSE = 0,
 427        SAFE_CRLF_FAIL = 1,
 428        SAFE_CRLF_WARN = 2,
 429};
 430
 431extern enum safe_crlf safe_crlf;
 432
 433enum branch_track {
 434        BRANCH_TRACK_NEVER = 0,
 435        BRANCH_TRACK_REMOTE,
 436        BRANCH_TRACK_ALWAYS,
 437        BRANCH_TRACK_EXPLICIT,
 438};
 439
 440extern enum branch_track git_branch_track;
 441
 442#define GIT_REPO_VERSION 0
 443extern int repository_format_version;
 444extern int check_repository_format(void);
 445
 446#define MTIME_CHANGED   0x0001
 447#define CTIME_CHANGED   0x0002
 448#define OWNER_CHANGED   0x0004
 449#define MODE_CHANGED    0x0008
 450#define INODE_CHANGED   0x0010
 451#define DATA_CHANGED    0x0020
 452#define TYPE_CHANGED    0x0040
 453
 454/* Return a statically allocated filename matching the sha1 signature */
 455extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 456extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 457extern char *sha1_file_name(const unsigned char *sha1);
 458extern char *sha1_pack_name(const unsigned char *sha1);
 459extern char *sha1_pack_index_name(const unsigned char *sha1);
 460extern const char *find_unique_abbrev(const unsigned char *sha1, int);
 461extern const unsigned char null_sha1[20];
 462static inline int is_null_sha1(const unsigned char *sha1)
 463{
 464        return !memcmp(sha1, null_sha1, 20);
 465}
 466static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
 467{
 468        return memcmp(sha1, sha2, 20);
 469}
 470static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
 471{
 472        memcpy(sha_dst, sha_src, 20);
 473}
 474static inline void hashclr(unsigned char *hash)
 475{
 476        memset(hash, 0, 20);
 477}
 478
 479int git_mkstemp(char *path, size_t n, const char *template);
 480
 481enum sharedrepo {
 482        PERM_UMASK = 0,
 483        PERM_GROUP,
 484        PERM_EVERYBODY
 485};
 486int git_config_perm(const char *var, const char *value);
 487int adjust_shared_perm(const char *path);
 488int safe_create_leading_directories(char *path);
 489char *enter_repo(char *path, int strict);
 490static inline int is_absolute_path(const char *path)
 491{
 492        return path[0] == '/';
 493}
 494const char *make_absolute_path(const char *path);
 495
 496/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
 497extern int sha1_object_info(const unsigned char *, unsigned long *);
 498extern void * read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size);
 499extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
 500extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
 501extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
 502
 503extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
 504
 505extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
 506                              size_t bufsize, size_t *bufposn);
 507extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
 508extern int move_temp_to_file(const char *tmpfile, const char *filename);
 509
 510extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
 511extern int has_sha1_file(const unsigned char *sha1);
 512
 513extern int has_pack_file(const unsigned char *sha1);
 514extern int has_pack_index(const unsigned char *sha1);
 515
 516extern const signed char hexval_table[256];
 517static inline unsigned int hexval(unsigned char c)
 518{
 519        return hexval_table[c];
 520}
 521
 522/* Convert to/from hex/sha1 representation */
 523#define MINIMUM_ABBREV 4
 524#define DEFAULT_ABBREV 7
 525
 526extern int get_sha1(const char *str, unsigned char *sha1);
 527extern int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode);
 528extern int get_sha1_hex(const char *hex, unsigned char *sha1);
 529extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
 530extern int read_ref(const char *filename, unsigned char *sha1);
 531extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
 532extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
 533extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
 534
 535extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
 536extern const char *ref_rev_parse_rules[];
 537extern const char *ref_fetch_rules[];
 538
 539extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
 540extern int validate_headref(const char *ref);
 541
 542extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
 543extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
 544extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
 545
 546extern void *read_object_with_reference(const unsigned char *sha1,
 547                                        const char *required_type,
 548                                        unsigned long *size,
 549                                        unsigned char *sha1_ret);
 550
 551extern struct object *peel_to_type(const char *name, int namelen,
 552                                   struct object *o, enum object_type);
 553
 554enum date_mode {
 555        DATE_NORMAL = 0,
 556        DATE_RELATIVE,
 557        DATE_SHORT,
 558        DATE_LOCAL,
 559        DATE_ISO8601,
 560        DATE_RFC2822
 561};
 562
 563const char *show_date(unsigned long time, int timezone, enum date_mode mode);
 564int parse_date(const char *date, char *buf, int bufsize);
 565void datestamp(char *buf, int bufsize);
 566unsigned long approxidate(const char *);
 567enum date_mode parse_date_format(const char *format);
 568
 569#define IDENT_WARN_ON_NO_NAME  1
 570#define IDENT_ERROR_ON_NO_NAME 2
 571#define IDENT_NO_DATE          4
 572extern const char *git_author_info(int);
 573extern const char *git_committer_info(int);
 574extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
 575extern const char *fmt_name(const char *name, const char *email);
 576
 577struct checkout {
 578        const char *base_dir;
 579        int base_dir_len;
 580        unsigned force:1,
 581                 quiet:1,
 582                 not_new:1,
 583                 refresh_cache:1;
 584};
 585
 586extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
 587extern int has_symlink_leading_path(const char *name, char *last_symlink);
 588
 589extern struct alternate_object_database {
 590        struct alternate_object_database *next;
 591        char *name;
 592        char base[FLEX_ARRAY]; /* more */
 593} *alt_odb_list;
 594extern void prepare_alt_odb(void);
 595
 596struct pack_window {
 597        struct pack_window *next;
 598        unsigned char *base;
 599        off_t offset;
 600        size_t len;
 601        unsigned int last_used;
 602        unsigned int inuse_cnt;
 603};
 604
 605extern struct packed_git {
 606        struct packed_git *next;
 607        struct pack_window *windows;
 608        off_t pack_size;
 609        const void *index_data;
 610        size_t index_size;
 611        uint32_t num_objects;
 612        int index_version;
 613        time_t mtime;
 614        int pack_fd;
 615        int pack_local;
 616        unsigned char sha1[20];
 617        /* something like ".git/objects/pack/xxxxx.pack" */
 618        char pack_name[FLEX_ARRAY]; /* more */
 619} *packed_git;
 620
 621struct pack_entry {
 622        off_t offset;
 623        unsigned char sha1[20];
 624        struct packed_git *p;
 625};
 626
 627struct ref {
 628        struct ref *next;
 629        unsigned char old_sha1[20];
 630        unsigned char new_sha1[20];
 631        unsigned int force:1,
 632                merge:1,
 633                nonfastforward:1,
 634                deletion:1;
 635        enum {
 636                REF_STATUS_NONE = 0,
 637                REF_STATUS_OK,
 638                REF_STATUS_REJECT_NONFASTFORWARD,
 639                REF_STATUS_REJECT_NODELETE,
 640                REF_STATUS_UPTODATE,
 641                REF_STATUS_REMOTE_REJECT,
 642                REF_STATUS_EXPECTING_REPORT,
 643        } status;
 644        char *remote_status;
 645        struct ref *peer_ref; /* when renaming */
 646        char name[FLEX_ARRAY]; /* more */
 647};
 648
 649#define REF_NORMAL      (1u << 0)
 650#define REF_HEADS       (1u << 1)
 651#define REF_TAGS        (1u << 2)
 652
 653extern struct ref *find_ref_by_name(struct ref *list, const char *name);
 654
 655#define CONNECT_VERBOSE       (1u << 0)
 656extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
 657extern int finish_connect(struct child_process *conn);
 658extern int path_match(const char *path, int nr, char **match);
 659extern int get_ack(int fd, unsigned char *result_sha1);
 660extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags);
 661extern int server_supports(const char *feature);
 662
 663extern struct packed_git *parse_pack_index(unsigned char *sha1);
 664extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
 665                                                const char *idx_path);
 666
 667extern void prepare_packed_git(void);
 668extern void reprepare_packed_git(void);
 669extern void install_packed_git(struct packed_git *pack);
 670
 671extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
 672                                         struct packed_git *packs);
 673
 674extern void pack_report(void);
 675extern int open_pack_index(struct packed_git *);
 676extern unsigned char* use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
 677extern void close_pack_windows(struct packed_git *);
 678extern void unuse_pack(struct pack_window **);
 679extern struct packed_git *add_packed_git(const char *, int, int);
 680extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
 681extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
 682extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
 683extern unsigned long unpack_object_header_gently(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
 684extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
 685extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
 686extern int matches_pack_name(struct packed_git *p, const char *name);
 687
 688/* Dumb servers support */
 689extern int update_server_info(int);
 690
 691typedef int (*config_fn_t)(const char *, const char *);
 692extern int git_default_config(const char *, const char *);
 693extern int git_config_from_file(config_fn_t fn, const char *);
 694extern int git_config(config_fn_t fn);
 695extern int git_parse_long(const char *, long *);
 696extern int git_parse_ulong(const char *, unsigned long *);
 697extern int git_config_int(const char *, const char *);
 698extern unsigned long git_config_ulong(const char *, const char *);
 699extern int git_config_bool(const char *, const char *);
 700extern int git_config_string(const char **, const char *, const char *);
 701extern int git_config_set(const char *, const char *);
 702extern int git_config_set_multivar(const char *, const char *, const char *, int);
 703extern int git_config_rename_section(const char *, const char *);
 704extern const char *git_etc_gitconfig(void);
 705extern int check_repository_format_version(const char *var, const char *value);
 706extern int git_env_bool(const char *, int);
 707extern int git_config_system(void);
 708extern int git_config_global(void);
 709extern int config_error_nonbool(const char *);
 710
 711#define MAX_GITNAME (1000)
 712extern char git_default_email[MAX_GITNAME];
 713extern char git_default_name[MAX_GITNAME];
 714
 715extern const char *git_commit_encoding;
 716extern const char *git_log_output_encoding;
 717
 718/* IO helper functions */
 719extern void maybe_flush_or_die(FILE *, const char *);
 720extern int copy_fd(int ifd, int ofd);
 721extern int copy_file(const char *dst, const char *src, int mode);
 722extern int read_in_full(int fd, void *buf, size_t count);
 723extern int write_in_full(int fd, const void *buf, size_t count);
 724extern void write_or_die(int fd, const void *buf, size_t count);
 725extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
 726extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
 727
 728/* pager.c */
 729extern void setup_pager(void);
 730extern const char *pager_program;
 731extern int pager_in_use(void);
 732extern int pager_use_color;
 733
 734extern const char *editor_program;
 735extern const char *excludes_file;
 736
 737/* base85 */
 738int decode_85(char *dst, const char *line, int linelen);
 739void encode_85(char *buf, const unsigned char *data, int bytes);
 740
 741/* alloc.c */
 742extern void *alloc_blob_node(void);
 743extern void *alloc_tree_node(void);
 744extern void *alloc_commit_node(void);
 745extern void *alloc_tag_node(void);
 746extern void *alloc_object_node(void);
 747extern void alloc_report(void);
 748
 749/* trace.c */
 750extern void trace_printf(const char *format, ...);
 751extern void trace_argv_printf(const char **argv, const char *format, ...);
 752
 753/* convert.c */
 754/* returns 1 if *dst was used */
 755extern int convert_to_git(const char *path, const char *src, size_t len,
 756                          struct strbuf *dst, enum safe_crlf checksafe);
 757extern int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst);
 758
 759/* add */
 760void add_files_to_cache(int verbose, const char *prefix, const char **pathspec);
 761
 762/* diff.c */
 763extern int diff_auto_refresh_index;
 764
 765/* match-trees.c */
 766void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
 767
 768/*
 769 * whitespace rules.
 770 * used by both diff and apply
 771 */
 772#define WS_TRAILING_SPACE       01
 773#define WS_SPACE_BEFORE_TAB     02
 774#define WS_INDENT_WITH_NON_TAB  04
 775#define WS_CR_AT_EOL           010
 776#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB)
 777extern unsigned whitespace_rule_cfg;
 778extern unsigned whitespace_rule(const char *);
 779extern unsigned parse_whitespace_rule(const char *);
 780extern unsigned check_and_emit_line(const char *line, int len, unsigned ws_rule,
 781    FILE *stream, const char *set,
 782    const char *reset, const char *ws);
 783extern char *whitespace_error_string(unsigned ws);
 784extern int ws_fix_copy(char *, const char *, int, unsigned, int *);
 785
 786/* ls-files */
 787int pathspec_match(const char **spec, char *matched, const char *filename, int skiplen);
 788int report_path_error(const char *ps_matched, const char **pathspec, int prefix_offset);
 789void overlay_tree_on_cache(const char *tree_name, const char *prefix);
 790
 791char *alias_lookup(const char *alias);
 792
 793#endif /* CACHE_H */