cache.h

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