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