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