cache.h

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