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