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