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 #include "advice.h"
   8 #include "gettext.h"
   9 #include "convert.h"
  10
  11 #include SHA1_HEADER
  12 #ifndef git_SHA_CTX
  13 #define git_SHA_CTX     SHA_CTX
  14 #define git_SHA1_Init   SHA1_Init
  15 #define git_SHA1_Update SHA1_Update
  16 #define git_SHA1_Final  SHA1_Final
  17 #endif
  18
  19 #include <zlib.h>
  20 typedef struct git_zstream {
  21         z_stream z;
  22         unsigned long avail_in;
  23         unsigned long avail_out;
  24         unsigned long total_in;
  25         unsigned long total_out;
  26         unsigned char *next_in;
  27         unsigned char *next_out;
  28 } git_zstream;
  29
  30 void git_inflate_init(git_zstream *);
  31 void git_inflate_init_gzip_only(git_zstream *);
  32 void git_inflate_end(git_zstream *);
  33 int git_inflate(git_zstream *, int flush);
  34
  35 void git_deflate_init(git_zstream *, int level);
  36 void git_deflate_init_gzip(git_zstream *, int level);
  37 void git_deflate_end(git_zstream *);
  38 int git_deflate_abort(git_zstream *);
  39 int git_deflate_end_gently(git_zstream *);
  40 int git_deflate(git_zstream *, int flush);
  41 unsigned long git_deflate_bound(git_zstream *, unsigned long);
  42
  43 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
  44 #define DTYPE(de)       ((de)->d_type)
  45 #else
  46 #undef DT_UNKNOWN
  47 #undef DT_DIR
  48 #undef DT_REG
  49 #undef DT_LNK
  50 #define DT_UNKNOWN      0
  51 #define DT_DIR          1
  52 #define DT_REG          2
  53 #define DT_LNK          3
  54 #define DTYPE(de)       DT_UNKNOWN
  55 #endif
  56
  57 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
  58 #define S_IFINVALID     0030000
  59
  60 /*
  61  * A "directory link" is a link to another git directory.
  62  *
  63  * The value 0160000 is not normally a valid mode, and
  64  * also just happens to be S_IFDIR + S_IFLNK
  65  *
  66  * NOTE! We *really* shouldn't depend on the S_IFxxx macros
  67  * always having the same values everywhere. We should use
  68  * our internal git values for these things, and then we can
  69  * translate that to the OS-specific value. It just so
  70  * happens that everybody shares the same bit representation
  71  * in the UNIX world (and apparently wider too..)
  72  */
  73 #define S_IFGITLINK     0160000
  74 #define S_ISGITLINK(m)  (((m) & S_IFMT) == S_IFGITLINK)
  75
  76 /*
  77  * Intensive research over the course of many years has shown that
  78  * port 9418 is totally unused by anything else. Or
  79  *
  80  *      Your search - "port 9418" - did not match any documents.
  81  *
  82  * as www.google.com puts it.
  83  *
  84  * This port has been properly assigned for git use by IANA:
  85  * git (Assigned-9418) [I06-050728-0001].
  86  *
  87  *      git  9418/tcp   git pack transfer service
  88  *      git  9418/udp   git pack transfer service
  89  *
  90  * with Linus Torvalds <torvalds@osdl.org> as the point of
  91  * contact. September 2005.
  92  *
  93  * See http://www.iana.org/assignments/port-numbers
  94  */
  95 #define DEFAULT_GIT_PORT 9418
  96
  97 /*
  98  * Basic data structures for the directory cache
  99  */
 100
 101 #define CACHE_SIGNATURE 0x44495243      /* "DIRC" */
 102 struct cache_header {
 103         unsigned int hdr_signature;
 104         unsigned int hdr_version;
 105         unsigned int hdr_entries;
 106 };
 107
 108 /*
 109  * The "cache_time" is just the low 32 bits of the
 110  * time. It doesn't matter if it overflows - we only
 111  * check it for equality in the 32 bits we save.
 112  */
 113 struct cache_time {
 114         unsigned int sec;
 115         unsigned int nsec;
 116 };
 117
 118 /*
 119  * dev/ino/uid/gid/size are also just tracked to the low 32 bits
 120  * Again - this is just a (very strong in practice) heuristic that
 121  * the inode hasn't changed.
 122  *
 123  * We save the fields in big-endian order to allow using the
 124  * index file over NFS transparently.
 125  */
 126 struct ondisk_cache_entry {
 127         struct cache_time ctime;
 128         struct cache_time mtime;
 129         unsigned int dev;
 130         unsigned int ino;
 131         unsigned int mode;
 132         unsigned int uid;
 133         unsigned int gid;
 134         unsigned int size;
 135         unsigned char sha1[20];
 136         unsigned short flags;
 137         char name[FLEX_ARRAY]; /* more */
 138 };
 139
 140 /*
 141  * This struct is used when CE_EXTENDED bit is 1
 142  * The struct must match ondisk_cache_entry exactly from
 143  * ctime till flags
 144  */
 145 struct ondisk_cache_entry_extended {
 146         struct cache_time ctime;
 147         struct cache_time mtime;
 148         unsigned int dev;
 149         unsigned int ino;
 150         unsigned int mode;
 151         unsigned int uid;
 152         unsigned int gid;
 153         unsigned int size;
 154         unsigned char sha1[20];
 155         unsigned short flags;
 156         unsigned short flags2;
 157         char name[FLEX_ARRAY]; /* more */
 158 };
 159
 160 struct cache_entry {
 161         struct cache_time ce_ctime;
 162         struct cache_time ce_mtime;
 163         unsigned int ce_dev;
 164         unsigned int ce_ino;
 165         unsigned int ce_mode;
 166         unsigned int ce_uid;
 167         unsigned int ce_gid;
 168         unsigned int ce_size;
 169         unsigned int ce_flags;
 170         unsigned char sha1[20];
 171         struct cache_entry *next;
 172         struct cache_entry *dir_next;
 173         char name[FLEX_ARRAY]; /* more */
 174 };
 175
 176 #define CE_NAMEMASK  (0x0fff)
 177 #define CE_STAGEMASK (0x3000)
 178 #define CE_EXTENDED  (0x4000)
 179 #define CE_VALID     (0x8000)
 180 #define CE_STAGESHIFT 12
 181
 182 /*
 183  * Range 0xFFFF0000 in ce_flags is divided into
 184  * two parts: in-memory flags and on-disk ones.
 185  * Flags in CE_EXTENDED_FLAGS will get saved on-disk
 186  * if you want to save a new flag, add it in
 187  * CE_EXTENDED_FLAGS
 188  *
 189  * In-memory only flags
 190  */
 191 #define CE_UPDATE            (1 << 16)
 192 #define CE_REMOVE            (1 << 17)
 193 #define CE_UPTODATE          (1 << 18)
 194 #define CE_ADDED             (1 << 19)
 195
 196 #define CE_HASHED            (1 << 20)
 197 #define CE_UNHASHED          (1 << 21)
 198 #define CE_WT_REMOVE         (1 << 22) /* remove in work directory */
 199 #define CE_CONFLICTED        (1 << 23)
 200
 201 #define CE_UNPACKED          (1 << 24)
 202 #define CE_NEW_SKIP_WORKTREE (1 << 25)
 203
 204 /*
 205  * Extended on-disk flags
 206  */
 207 #define CE_INTENT_TO_ADD     (1 << 29)
 208 #define CE_SKIP_WORKTREE     (1 << 30)
 209 /* CE_EXTENDED2 is for future extension */
 210 #define CE_EXTENDED2         (1 << 31)
 211
 212 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
 213
 214 /*
 215  * Safeguard to avoid saving wrong flags:
 216  *  - CE_EXTENDED2 won't get saved until its semantic is known
 217  *  - Bits in 0x0000FFFF have been saved in ce_flags already
 218  *  - Bits in 0x003F0000 are currently in-memory flags
 219  */
 220 #if CE_EXTENDED_FLAGS & 0x803FFFFF
 221 #error "CE_EXTENDED_FLAGS out of range"
 222 #endif
 223
 224 /*
 225  * Copy the sha1 and stat state of a cache entry from one to
 226  * another. But we never change the name, or the hash state!
 227  */
 228 #define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
 229 static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
 230 {
 231         unsigned int state = dst->ce_flags & CE_STATE_MASK;
 232
 233         /* Don't copy hash chain and name */
 234         memcpy(dst, src, offsetof(struct cache_entry, next));
 235
 236         /* Restore the hash state */
 237         dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
 238 }
 239
 240 static inline unsigned create_ce_flags(size_t len, unsigned stage)
 241 {
 242         if (len >= CE_NAMEMASK)
 243                 len = CE_NAMEMASK;
 244         return (len | (stage << CE_STAGESHIFT));
 245 }
 246
 247 static inline size_t ce_namelen(const struct cache_entry *ce)
 248 {
 249         size_t len = ce->ce_flags & CE_NAMEMASK;
 250         if (len < CE_NAMEMASK)
 251                 return len;
 252         return strlen(ce->name + CE_NAMEMASK) + CE_NAMEMASK;
 253 }
 254
 255 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
 256 #define ondisk_ce_size(ce) (((ce)->ce_flags & CE_EXTENDED) ? \
 257                             ondisk_cache_entry_extended_size(ce_namelen(ce)) : \
 258                             ondisk_cache_entry_size(ce_namelen(ce)))
 259 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
 260 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
 261 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
 262 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
 263
 264 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
 265 static inline unsigned int create_ce_mode(unsigned int mode)
 266 {
 267         if (S_ISLNK(mode))
 268                 return S_IFLNK;
 269         if (S_ISDIR(mode) || S_ISGITLINK(mode))
 270                 return S_IFGITLINK;
 271         return S_IFREG | ce_permissions(mode);
 272 }
 273 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
 274 {
 275         extern int trust_executable_bit, has_symlinks;
 276         if (!has_symlinks && S_ISREG(mode) &&
 277             ce && S_ISLNK(ce->ce_mode))
 278                 return ce->ce_mode;
 279         if (!trust_executable_bit && S_ISREG(mode)) {
 280                 if (ce && S_ISREG(ce->ce_mode))
 281                         return ce->ce_mode;
 282                 return create_ce_mode(0666);
 283         }
 284         return create_ce_mode(mode);
 285 }
 286 static inline int ce_to_dtype(const struct cache_entry *ce)
 287 {
 288         unsigned ce_mode = ntohl(ce->ce_mode);
 289         if (S_ISREG(ce_mode))
 290                 return DT_REG;
 291         else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
 292                 return DT_DIR;
 293         else if (S_ISLNK(ce_mode))
 294                 return DT_LNK;
 295         else
 296                 return DT_UNKNOWN;
 297 }
 298 static inline unsigned int canon_mode(unsigned int mode)
 299 {
 300         if (S_ISREG(mode))
 301                 return S_IFREG | ce_permissions(mode);
 302         if (S_ISLNK(mode))
 303                 return S_IFLNK;
 304         if (S_ISDIR(mode))
 305                 return S_IFDIR;
 306         return S_IFGITLINK;
 307 }
 308
 309 #define flexible_size(STRUCT,len) ((offsetof(struct STRUCT,name) + (len) + 8) & ~7)
 310 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
 311 #define ondisk_cache_entry_size(len) flexible_size(ondisk_cache_entry,len)
 312 #define ondisk_cache_entry_extended_size(len) flexible_size(ondisk_cache_entry_extended,len)
 313
 314 struct index_state {
 315         struct cache_entry **cache;
 316         unsigned int cache_nr, cache_alloc, cache_changed;
 317         struct string_list *resolve_undo;
 318         struct cache_tree *cache_tree;
 319         struct cache_time timestamp;
 320         unsigned name_hash_initialized : 1,
 321                  initialized : 1;
 322         struct hash_table name_hash;
 323 };
 324
 325 extern struct index_state the_index;
 326
 327 /* Name hashing */
 328 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
 329 /*
 330  * We don't actually *remove* it, we can just mark it invalid so that
 331  * we won't find it in lookups.
 332  *
 333  * Not only would we have to search the lists (simple enough), but
 334  * we'd also have to rehash other hash buckets in case this makes the
 335  * hash bucket empty (common). So it's much better to just mark
 336  * it.
 337  */
 338 static inline void remove_name_hash(struct cache_entry *ce)
 339 {
 340         ce->ce_flags |= CE_UNHASHED;
 341 }
 342
 343
 344 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
 345 #define active_cache (the_index.cache)
 346 #define active_nr (the_index.cache_nr)
 347 #define active_alloc (the_index.cache_alloc)
 348 #define active_cache_changed (the_index.cache_changed)
 349 #define active_cache_tree (the_index.cache_tree)
 350
 351 #define read_cache() read_index(&the_index)
 352 #define read_cache_from(path) read_index_from(&the_index, (path))
 353 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
 354 #define is_cache_unborn() is_index_unborn(&the_index)
 355 #define read_cache_unmerged() read_index_unmerged(&the_index)
 356 #define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
 357 #define discard_cache() discard_index(&the_index)
 358 #define unmerged_cache() unmerged_index(&the_index)
 359 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
 360 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
 361 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
 362 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
 363 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
 364 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
 365 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
 366 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
 367 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
 368 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
 369 #define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
 370 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
 371 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
 372 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
 373 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
 374 #endif
 375
 376 enum object_type {
 377         OBJ_BAD = -1,
 378         OBJ_NONE = 0,
 379         OBJ_COMMIT = 1,
 380         OBJ_TREE = 2,
 381         OBJ_BLOB = 3,
 382         OBJ_TAG = 4,
 383         /* 5 for future expansion */
 384         OBJ_OFS_DELTA = 6,
 385         OBJ_REF_DELTA = 7,
 386         OBJ_ANY,
 387         OBJ_MAX
 388 };
 389
 390 static inline enum object_type object_type(unsigned int mode)
 391 {
 392         return S_ISDIR(mode) ? OBJ_TREE :
 393                 S_ISGITLINK(mode) ? OBJ_COMMIT :
 394                 OBJ_BLOB;
 395 }
 396
 397 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
 398 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
 399 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
 400 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
 401 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
 402 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
 403 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
 404 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
 405 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
 406 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
 407 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
 408 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
 409 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
 410 #define GITATTRIBUTES_FILE ".gitattributes"
 411 #define INFOATTRIBUTES_FILE "info/attributes"
 412 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
 413 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
 414 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
 415 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
 416 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
 417 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
 418
 419 /*
 420  * Repository-local GIT_* environment variables
 421  * The array is NULL-terminated to simplify its usage in contexts such
 422  * environment creation or simple walk of the list.
 423  * The number of non-NULL entries is available as a macro.
 424  */
 425 #define LOCAL_REPO_ENV_SIZE 9
 426 extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];
 427
 428 extern int is_bare_repository_cfg;
 429 extern int is_bare_repository(void);
 430 extern int is_inside_git_dir(void);
 431 extern char *git_work_tree_cfg;
 432 extern int is_inside_work_tree(void);
 433 extern int have_git_dir(void);
 434 extern const char *get_git_dir(void);
 435 extern int is_git_directory(const char *path);
 436 extern char *get_object_directory(void);
 437 extern char *get_index_file(void);
 438 extern char *get_graft_file(void);
 439 extern int set_git_dir(const char *path);
 440 extern const char *get_git_namespace(void);
 441 extern const char *strip_namespace(const char *namespaced_ref);
 442 extern const char *get_git_work_tree(void);
 443 extern const char *read_gitfile(const char *path);
 444 extern const char *resolve_gitdir(const char *suspect);
 445 extern void set_git_work_tree(const char *tree);
 446
 447 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
 448
 449 extern const char **get_pathspec(const char *prefix, const char **pathspec);
 450 extern void setup_work_tree(void);
 451 extern const char *setup_git_directory_gently(int *);
 452 extern const char *setup_git_directory(void);
 453 extern char *prefix_path(const char *prefix, int len, const char *path);
 454 extern const char *prefix_filename(const char *prefix, int len, const char *path);
 455 extern int check_filename(const char *prefix, const char *name);
 456 extern void verify_filename(const char *prefix, const char *name);
 457 extern void verify_non_filename(const char *prefix, const char *name);
 458
 459 #define INIT_DB_QUIET 0x0001
 460
 461 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
 462 extern int init_db(const char *template_dir, unsigned int flags);
 463
 464 #define alloc_nr(x) (((x)+16)*3/2)
 465
 466 /*
 467  * Realloc the buffer pointed at by variable 'x' so that it can hold
 468  * at least 'nr' entries; the number of entries currently allocated
 469  * is 'alloc', using the standard growing factor alloc_nr() macro.
 470  *
 471  * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
 472  */
 473 #define ALLOC_GROW(x, nr, alloc) \
 474         do { \
 475                 if ((nr) > alloc) { \
 476                         if (alloc_nr(alloc) < (nr)) \
 477                                 alloc = (nr); \
 478                         else \
 479                                 alloc = alloc_nr(alloc); \
 480                         x = xrealloc((x), alloc * sizeof(*(x))); \
 481                 } \
 482         } while (0)
 483
 484 /* Initialize and use the cache information */
 485 extern int read_index(struct index_state *);
 486 extern int read_index_preload(struct index_state *, const char **pathspec);
 487 extern int read_index_from(struct index_state *, const char *path);
 488 extern int is_index_unborn(struct index_state *);
 489 extern int read_index_unmerged(struct index_state *);
 490 extern int write_index(struct index_state *, int newfd);
 491 extern int discard_index(struct index_state *);
 492 extern int unmerged_index(const struct index_state *);
 493 extern int verify_path(const char *path);
 494 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
 495 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
 496 #define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
 497 #define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
 498 #define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
 499 #define ADD_CACHE_JUST_APPEND 8         /* Append only; tree.c::read_tree() */
 500 #define ADD_CACHE_NEW_ONLY 16           /* Do not replace existing ones */
 501 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
 502 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
 503 extern int remove_index_entry_at(struct index_state *, int pos);
 504 extern void remove_marked_cache_entries(struct index_state *istate);
 505 extern int remove_file_from_index(struct index_state *, const char *path);
 506 #define ADD_CACHE_VERBOSE 1
 507 #define ADD_CACHE_PRETEND 2
 508 #define ADD_CACHE_IGNORE_ERRORS 4
 509 #define ADD_CACHE_IGNORE_REMOVAL 8
 510 #define ADD_CACHE_INTENT 16
 511 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
 512 extern int add_file_to_index(struct index_state *, const char *path, int flags);
 513 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
 514 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
 515 extern int index_name_is_other(const struct index_state *, const char *, int);
 516
 517 /* do stat comparison even if CE_VALID is true */
 518 #define CE_MATCH_IGNORE_VALID           01
 519 /* do not check the contents but report dirty on racily-clean entries */
 520 #define CE_MATCH_RACY_IS_DIRTY          02
 521 /* do stat comparison even if CE_SKIP_WORKTREE is true */
 522 #define CE_MATCH_IGNORE_SKIP_WORKTREE   04
 523 extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
 524 extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
 525
 526 struct pathspec {
 527         const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
 528         int nr;
 529         unsigned int has_wildcard:1;
 530         unsigned int recursive:1;
 531         int max_depth;
 532         struct pathspec_item {
 533                 const char *match;
 534                 int len;
 535                 unsigned int use_wildcard:1;
 536         } *items;
 537 };
 538
 539 extern int init_pathspec(struct pathspec *, const char **);
 540 extern void free_pathspec(struct pathspec *);
 541 extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
 542
 543 #define HASH_WRITE_OBJECT 1
 544 #define HASH_FORMAT_CHECK 2
 545 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
 546 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
 547 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
 548
 549 #define REFRESH_REALLY          0x0001  /* ignore_valid */
 550 #define REFRESH_UNMERGED        0x0002  /* allow unmerged */
 551 #define REFRESH_QUIET           0x0004  /* be quiet about it */
 552 #define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
 553 #define REFRESH_IGNORE_SUBMODULES       0x0010  /* ignore submodules */
 554 #define REFRESH_IN_PORCELAIN    0x0020  /* user friendly output, not "needs update" */
 555 extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, const char *header_msg);
 556
 557 struct lock_file {
 558         struct lock_file *next;
 559         int fd;
 560         pid_t owner;
 561         char on_list;
 562         char filename[PATH_MAX];
 563 };
 564 #define LOCK_DIE_ON_ERROR 1
 565 #define LOCK_NODEREF 2
 566 extern int unable_to_lock_error(const char *path, int err);
 567 extern NORETURN void unable_to_lock_index_die(const char *path, int err);
 568 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
 569 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
 570 extern int commit_lock_file(struct lock_file *);
 571 extern void update_index_if_able(struct index_state *, struct lock_file *);
 572
 573 extern int hold_locked_index(struct lock_file *, int);
 574 extern int commit_locked_index(struct lock_file *);
 575 extern void set_alternate_index_output(const char *);
 576 extern int close_lock_file(struct lock_file *);
 577 extern void rollback_lock_file(struct lock_file *);
 578 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
 579
 580 /* Environment bits from configuration mechanism */
 581 extern int trust_executable_bit;
 582 extern int trust_ctime;
 583 extern int quote_path_fully;
 584 extern int has_symlinks;
 585 extern int minimum_abbrev, default_abbrev;
 586 extern int ignore_case;
 587 extern int assume_unchanged;
 588 extern int prefer_symlink_refs;
 589 extern int log_all_ref_updates;
 590 extern int warn_ambiguous_refs;
 591 extern int shared_repository;
 592 extern const char *apply_default_whitespace;
 593 extern const char *apply_default_ignorewhitespace;
 594 extern const char *git_attributes_file;
 595 extern int zlib_compression_level;
 596 extern int core_compression_level;
 597 extern int core_compression_seen;
 598 extern size_t packed_git_window_size;
 599 extern size_t packed_git_limit;
 600 extern size_t delta_base_cache_limit;
 601 extern unsigned long big_file_threshold;
 602 extern unsigned long pack_size_limit_cfg;
 603 extern int read_replace_refs;
 604 extern int fsync_object_files;
 605 extern int core_preload_index;
 606 extern int core_apply_sparse_checkout;
 607
 608 enum branch_track {
 609         BRANCH_TRACK_UNSPECIFIED = -1,
 610         BRANCH_TRACK_NEVER = 0,
 611         BRANCH_TRACK_REMOTE,
 612         BRANCH_TRACK_ALWAYS,
 613         BRANCH_TRACK_EXPLICIT,
 614         BRANCH_TRACK_OVERRIDE
 615 };
 616
 617 enum rebase_setup_type {
 618         AUTOREBASE_NEVER = 0,
 619         AUTOREBASE_LOCAL,
 620         AUTOREBASE_REMOTE,
 621         AUTOREBASE_ALWAYS
 622 };
 623
 624 enum push_default_type {
 625         PUSH_DEFAULT_NOTHING = 0,
 626         PUSH_DEFAULT_MATCHING,
 627         PUSH_DEFAULT_UPSTREAM,
 628         PUSH_DEFAULT_CURRENT
 629 };
 630
 631 extern enum branch_track git_branch_track;
 632 extern enum rebase_setup_type autorebase;
 633 extern enum push_default_type push_default;
 634
 635 enum object_creation_mode {
 636         OBJECT_CREATION_USES_HARDLINKS = 0,
 637         OBJECT_CREATION_USES_RENAMES = 1
 638 };
 639
 640 extern enum object_creation_mode object_creation_mode;
 641
 642 extern char *notes_ref_name;
 643
 644 extern int grafts_replace_parents;
 645
 646 #define GIT_REPO_VERSION 0
 647 extern int repository_format_version;
 648 extern int check_repository_format(void);
 649
 650 #define MTIME_CHANGED   0x0001
 651 #define CTIME_CHANGED   0x0002
 652 #define OWNER_CHANGED   0x0004
 653 #define MODE_CHANGED    0x0008
 654 #define INODE_CHANGED   0x0010
 655 #define DATA_CHANGED    0x0020
 656 #define TYPE_CHANGED    0x0040
 657
 658 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
 659         __attribute__((format (printf, 3, 4)));
 660 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
 661         __attribute__((format (printf, 3, 4)));
 662 extern char *git_pathdup(const char *fmt, ...)
 663         __attribute__((format (printf, 1, 2)));
 664
 665 /* Return a statically allocated filename matching the sha1 signature */
 666 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 667 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 668 extern char *git_path_submodule(const char *path, const char *fmt, ...)
 669         __attribute__((format (printf, 2, 3)));
 670
 671 extern char *sha1_file_name(const unsigned char *sha1);
 672 extern char *sha1_pack_name(const unsigned char *sha1);
 673 extern char *sha1_pack_index_name(const unsigned char *sha1);
 674 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
 675 extern const unsigned char null_sha1[20];
 676
 677 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
 678 {
 679         int i;
 680
 681         for (i = 0; i < 20; i++, sha1++, sha2++) {
 682                 if (*sha1 != *sha2)
 683                         return *sha1 - *sha2;
 684         }
 685
 686         return 0;
 687 }
 688
 689 static inline int is_null_sha1(const unsigned char *sha1)
 690 {
 691         return !hashcmp(sha1, null_sha1);
 692 }
 693
 694 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
 695 {
 696         memcpy(sha_dst, sha_src, 20);
 697 }
 698 static inline void hashclr(unsigned char *hash)
 699 {
 700         memset(hash, 0, 20);
 701 }
 702
 703 #define EMPTY_TREE_SHA1_HEX \
 704         "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
 705 #define EMPTY_TREE_SHA1_BIN_LITERAL \
 706          "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
 707          "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
 708 #define EMPTY_TREE_SHA1_BIN \
 709          ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
 710
 711 int git_mkstemp(char *path, size_t n, const char *template);
 712
 713 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
 714
 715 /* set default permissions by passing mode arguments to open(2) */
 716 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
 717 int git_mkstemp_mode(char *pattern, int mode);
 718
 719 /*
 720  * NOTE NOTE NOTE!!
 721  *
 722  * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
 723  * not be changed. Old repositories have core.sharedrepository written in
 724  * numeric format, and therefore these values are preserved for compatibility
 725  * reasons.
 726  */
 727 enum sharedrepo {
 728         PERM_UMASK          = 0,
 729         OLD_PERM_GROUP      = 1,
 730         OLD_PERM_EVERYBODY  = 2,
 731         PERM_GROUP          = 0660,
 732         PERM_EVERYBODY      = 0664
 733 };
 734 int git_config_perm(const char *var, const char *value);
 735 int set_shared_perm(const char *path, int mode);
 736 #define adjust_shared_perm(path) set_shared_perm((path), 0)
 737 int safe_create_leading_directories(char *path);
 738 int safe_create_leading_directories_const(const char *path);
 739 int mkdir_in_gitdir(const char *path);
 740 extern char *expand_user_path(const char *path);
 741 const char *enter_repo(const char *path, int strict);
 742 static inline int is_absolute_path(const char *path)
 743 {
 744         return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
 745 }
 746 int is_directory(const char *);
 747 const char *real_path(const char *path);
 748 const char *absolute_path(const char *path);
 749 const char *relative_path(const char *abs, const char *base);
 750 int normalize_path_copy(char *dst, const char *src);
 751 int longest_ancestor_length(const char *path, const char *prefix_list);
 752 char *strip_path_suffix(const char *path, const char *suffix);
 753 int daemon_avoid_alias(const char *path);
 754 int offset_1st_component(const char *path);
 755
 756 /* object replacement */
 757 #define READ_SHA1_FILE_REPLACE 1
 758 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
 759 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
 760 {
 761         return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
 762 }
 763 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
 764 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
 765 {
 766         if (!read_replace_refs)
 767                 return sha1;
 768         return do_lookup_replace_object(sha1);
 769 }
 770
 771 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
 772 extern int sha1_object_info(const unsigned char *, unsigned long *);
 773 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
 774 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
 775 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
 776 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
 777 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
 778 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
 779 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
 780
 781 /* global flag to enable extra checks when accessing packed objects */
 782 extern int do_check_packed_object_crc;
 783
 784 /* for development: log offset of pack access */
 785 extern const char *log_pack_access;
 786
 787 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
 788
 789 extern int move_temp_to_file(const char *tmpfile, const char *filename);
 790
 791 extern int has_sha1_pack(const unsigned char *sha1);
 792 extern int has_sha1_file(const unsigned char *sha1);
 793 extern int has_loose_object_nonlocal(const unsigned char *sha1);
 794
 795 extern int has_pack_index(const unsigned char *sha1);
 796
 797 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
 798
 799 extern const signed char hexval_table[256];
 800 static inline unsigned int hexval(unsigned char c)
 801 {
 802         return hexval_table[c];
 803 }
 804
 805 /* Convert to/from hex/sha1 representation */
 806 #define MINIMUM_ABBREV minimum_abbrev
 807 #define DEFAULT_ABBREV default_abbrev
 808
 809 struct object_context {
 810         unsigned char tree[20];
 811         char path[PATH_MAX];
 812         unsigned mode;
 813 };
 814
 815 extern int get_sha1(const char *str, unsigned char *sha1);
 816 extern int get_sha1_with_mode_1(const char *str, unsigned char *sha1, unsigned *mode, int only_to_die, const char *prefix);
 817 static inline int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode)
 818 {
 819         return get_sha1_with_mode_1(str, sha1, mode, 0, NULL);
 820 }
 821 extern int get_sha1_with_context_1(const char *name, unsigned char *sha1, struct object_context *orc, int only_to_die, const char *prefix);
 822 static inline int get_sha1_with_context(const char *str, unsigned char *sha1, struct object_context *orc)
 823 {
 824         return get_sha1_with_context_1(str, sha1, orc, 0, NULL);
 825 }
 826
 827 /*
 828  * Try to read a SHA1 in hexadecimal format from the 40 characters
 829  * starting at hex.  Write the 20-byte result to sha1 in binary form.
 830  * Return 0 on success.  Reading stops if a NUL is encountered in the
 831  * input, so it is safe to pass this function an arbitrary
 832  * null-terminated string.
 833  */
 834 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
 835
 836 extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
 837 extern int read_ref_full(const char *refname, unsigned char *sha1,
 838                          int reading, int *flags);
 839 extern int read_ref(const char *refname, unsigned char *sha1);
 840
 841 /*
 842  * Resolve a reference, recursively following symbolic refererences.
 843  *
 844  * Store the referred-to object's name in sha1 and return the name of
 845  * the non-symbolic reference that ultimately pointed at it.  The
 846  * return value, if not NULL, is a pointer into either a static buffer
 847  * or the input ref.
 848  *
 849  * If the reference cannot be resolved to an object, the behavior
 850  * depends on the "reading" argument:
 851  *
 852  * - If reading is set, return NULL.
 853  *
 854  * - If reading is not set, clear sha1 and return the name of the last
 855  *   reference name in the chain, which will either be a non-symbolic
 856  *   reference or an undefined reference.  If this is a prelude to
 857  *   "writing" to the ref, the return value is the name of the ref
 858  *   that will actually be created or changed.
 859  *
 860  * If flag is non-NULL, set the value that it points to the
 861  * combination of REF_ISPACKED (if the reference was found among the
 862  * packed references) and REF_ISSYMREF (if the initial reference was a
 863  * symbolic reference).
 864  *
 865  * If ref is not a properly-formatted, normalized reference, return
 866  * NULL.  If more than MAXDEPTH recursive symbolic lookups are needed,
 867  * give up and return NULL.
 868  *
 869  * errno is sometimes set on errors, but not always.
 870  */
 871 extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
 872 extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
 873
 874 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
 875 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
 876 extern int interpret_branch_name(const char *str, struct strbuf *);
 877 extern int get_sha1_mb(const char *str, unsigned char *sha1);
 878
 879 extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
 880 extern const char *ref_rev_parse_rules[];
 881 #define ref_fetch_rules ref_rev_parse_rules
 882
 883 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
 884 extern int validate_headref(const char *ref);
 885
 886 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
 887 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
 888 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
 889
 890 extern void *read_object_with_reference(const unsigned char *sha1,
 891                                         const char *required_type,
 892                                         unsigned long *size,
 893                                         unsigned char *sha1_ret);
 894
 895 extern struct object *peel_to_type(const char *name, int namelen,
 896                                    struct object *o, enum object_type);
 897
 898 enum date_mode {
 899         DATE_NORMAL = 0,
 900         DATE_RELATIVE,
 901         DATE_SHORT,
 902         DATE_LOCAL,
 903         DATE_ISO8601,
 904         DATE_RFC2822,
 905         DATE_RAW
 906 };
 907
 908 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
 909 const char *show_date_relative(unsigned long time, int tz,
 910                                const struct timeval *now,
 911                                char *timebuf,
 912                                size_t timebuf_size);
 913 int parse_date(const char *date, char *buf, int bufsize);
 914 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
 915 void datestamp(char *buf, int bufsize);
 916 #define approxidate(s) approxidate_careful((s), NULL)
 917 unsigned long approxidate_careful(const char *, int *);
 918 unsigned long approxidate_relative(const char *date, const struct timeval *now);
 919 enum date_mode parse_date_format(const char *format);
 920
 921 #define IDENT_WARN_ON_NO_NAME  1
 922 #define IDENT_ERROR_ON_NO_NAME 2
 923 #define IDENT_NO_DATE          4
 924 extern const char *git_author_info(int);
 925 extern const char *git_committer_info(int);
 926 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
 927 extern const char *fmt_name(const char *name, const char *email);
 928 extern const char *git_editor(void);
 929 extern const char *git_pager(int stdout_is_tty);
 930
 931 struct checkout {
 932         const char *base_dir;
 933         int base_dir_len;
 934         unsigned force:1,
 935                  quiet:1,
 936                  not_new:1,
 937                  refresh_cache:1;
 938 };
 939
 940 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
 941
 942 struct cache_def {
 943         char path[PATH_MAX + 1];
 944         int len;
 945         int flags;
 946         int track_flags;
 947         int prefix_len_stat_func;
 948 };
 949
 950 extern int has_symlink_leading_path(const char *name, int len);
 951 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
 952 extern int check_leading_path(const char *name, int len);
 953 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
 954 extern void schedule_dir_for_removal(const char *name, int len);
 955 extern void remove_scheduled_dirs(void);
 956
 957 extern struct alternate_object_database {
 958         struct alternate_object_database *next;
 959         char *name;
 960         char base[FLEX_ARRAY]; /* more */
 961 } *alt_odb_list;
 962 extern void prepare_alt_odb(void);
 963 extern void add_to_alternates_file(const char *reference);
 964 typedef int alt_odb_fn(struct alternate_object_database *, void *);
 965 extern void foreach_alt_odb(alt_odb_fn, void*);
 966
 967 struct pack_window {
 968         struct pack_window *next;
 969         unsigned char *base;
 970         off_t offset;
 971         size_t len;
 972         unsigned int last_used;
 973         unsigned int inuse_cnt;
 974 };
 975
 976 extern struct packed_git {
 977         struct packed_git *next;
 978         struct pack_window *windows;
 979         off_t pack_size;
 980         const void *index_data;
 981         size_t index_size;
 982         uint32_t num_objects;
 983         uint32_t num_bad_objects;
 984         unsigned char *bad_object_sha1;
 985         int index_version;
 986         time_t mtime;
 987         int pack_fd;
 988         unsigned pack_local:1,
 989                  pack_keep:1,
 990                  do_not_close:1;
 991         unsigned char sha1[20];
 992         /* something like ".git/objects/pack/xxxxx.pack" */
 993         char pack_name[FLEX_ARRAY]; /* more */
 994 } *packed_git;
 995
 996 struct pack_entry {
 997         off_t offset;
 998         unsigned char sha1[20];
 999         struct packed_git *p;
1000 };
1001
1002 struct ref {
1003         struct ref *next;
1004         unsigned char old_sha1[20];
1005         unsigned char new_sha1[20];
1006         char *symref;
1007         unsigned int force:1,
1008                 merge:1,
1009                 nonfastforward:1,
1010                 deletion:1;
1011         enum {
1012                 REF_STATUS_NONE = 0,
1013                 REF_STATUS_OK,
1014                 REF_STATUS_REJECT_NONFASTFORWARD,
1015                 REF_STATUS_REJECT_NODELETE,
1016                 REF_STATUS_UPTODATE,
1017                 REF_STATUS_REMOTE_REJECT,
1018                 REF_STATUS_EXPECTING_REPORT
1019         } status;
1020         char *remote_status;
1021         struct ref *peer_ref; /* when renaming */
1022         char name[FLEX_ARRAY]; /* more */
1023 };
1024
1025 #define REF_NORMAL      (1u << 0)
1026 #define REF_HEADS       (1u << 1)
1027 #define REF_TAGS        (1u << 2)
1028
1029 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
1030
1031 #define CONNECT_VERBOSE       (1u << 0)
1032 extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
1033 extern int finish_connect(struct child_process *conn);
1034 extern int git_connection_is_socket(struct child_process *conn);
1035 struct extra_have_objects {
1036         int nr, alloc;
1037         unsigned char (*array)[20];
1038 };
1039 extern struct ref **get_remote_heads(int in, struct ref **list, unsigned int flags, struct extra_have_objects *);
1040 extern int server_supports(const char *feature);
1041 extern const char *parse_feature_request(const char *features, const char *feature);
1042
1043 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1044
1045 extern void prepare_packed_git(void);
1046 extern void reprepare_packed_git(void);
1047 extern void install_packed_git(struct packed_git *pack);
1048
1049 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1050                                          struct packed_git *packs);
1051
1052 extern void pack_report(void);
1053 extern int open_pack_index(struct packed_git *);
1054 extern void close_pack_index(struct packed_git *);
1055 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1056 extern void close_pack_windows(struct packed_git *);
1057 extern void unuse_pack(struct pack_window **);
1058 extern void free_pack_by_name(const char *);
1059 extern void clear_delta_base_cache(void);
1060 extern struct packed_git *add_packed_git(const char *, int, int);
1061 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
1062 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
1063 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
1064 extern int is_pack_valid(struct packed_git *);
1065 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1066 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1067 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1068 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1069
1070 struct object_info {
1071         /* Request */
1072         unsigned long *sizep;
1073
1074         /* Response */
1075         enum {
1076                 OI_CACHED,
1077                 OI_LOOSE,
1078                 OI_PACKED,
1079                 OI_DBCACHED
1080         } whence;
1081         union {
1082                 /*
1083                  * struct {
1084                  *      ... Nothing to expose in this case
1085                  * } cached;
1086                  * struct {
1087                  *      ... Nothing to expose in this case
1088                  * } loose;
1089                  */
1090                 struct {
1091                         struct packed_git *pack;
1092                         off_t offset;
1093                         unsigned int is_delta;
1094                 } packed;
1095         } u;
1096 };
1097 extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
1098
1099 /* Dumb servers support */
1100 extern int update_server_info(int);
1101
1102 /* git_config_parse_key() returns these negated: */
1103 #define CONFIG_INVALID_KEY 1
1104 #define CONFIG_NO_SECTION_OR_NAME 2
1105 /* git_config_set(), git_config_set_multivar() return the above or these: */
1106 #define CONFIG_NO_LOCK -1
1107 #define CONFIG_INVALID_FILE 3
1108 #define CONFIG_NO_WRITE 4
1109 #define CONFIG_NOTHING_SET 5
1110 #define CONFIG_INVALID_PATTERN 6
1111
1112 typedef int (*config_fn_t)(const char *, const char *, void *);
1113 extern int git_default_config(const char *, const char *, void *);
1114 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1115 extern void git_config_push_parameter(const char *text);
1116 extern int git_config_from_parameters(config_fn_t fn, void *data);
1117 extern int git_config(config_fn_t fn, void *);
1118 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1119 extern int git_parse_ulong(const char *, unsigned long *);
1120 extern int git_config_int(const char *, const char *);
1121 extern unsigned long git_config_ulong(const char *, const char *);
1122 extern int git_config_bool_or_int(const char *, const char *, int *);
1123 extern int git_config_bool(const char *, const char *);
1124 extern int git_config_maybe_bool(const char *, const char *);
1125 extern int git_config_string(const char **, const char *, const char *);
1126 extern int git_config_pathname(const char **, const char *, const char *);
1127 extern int git_config_set_in_file(const char *, const char *, const char *);
1128 extern int git_config_set(const char *, const char *);
1129 extern int git_config_parse_key(const char *, char **, int *);
1130 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1131 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1132 extern int git_config_rename_section(const char *, const char *);
1133 extern const char *git_etc_gitconfig(void);
1134 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1135 extern int git_env_bool(const char *, int);
1136 extern int git_config_system(void);
1137 extern int config_error_nonbool(const char *);
1138 extern const char *get_log_output_encoding(void);
1139 extern const char *get_commit_output_encoding(void);
1140
1141 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1142
1143 extern const char *config_exclusive_filename;
1144
1145 #define MAX_GITNAME (1000)
1146 extern char git_default_email[MAX_GITNAME];
1147 extern char git_default_name[MAX_GITNAME];
1148 #define IDENT_NAME_GIVEN 01
1149 #define IDENT_MAIL_GIVEN 02
1150 #define IDENT_ALL_GIVEN (IDENT_NAME_GIVEN|IDENT_MAIL_GIVEN)
1151 extern int user_ident_explicitly_given;
1152 extern int user_ident_sufficiently_given(void);
1153
1154 extern const char *git_commit_encoding;
1155 extern const char *git_log_output_encoding;
1156 extern const char *git_mailmap_file;
1157
1158 /* IO helper functions */
1159 extern void maybe_flush_or_die(FILE *, const char *);
1160 extern int copy_fd(int ifd, int ofd);
1161 extern int copy_file(const char *dst, const char *src, int mode);
1162 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1163 extern void write_or_die(int fd, const void *buf, size_t count);
1164 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1165 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1166 extern void fsync_or_die(int fd, const char *);
1167
1168 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1169 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1170 static inline ssize_t write_str_in_full(int fd, const char *str)
1171 {
1172         return write_in_full(fd, str, strlen(str));
1173 }
1174
1175 /* pager.c */
1176 extern void setup_pager(void);
1177 extern const char *pager_program;
1178 extern int pager_in_use(void);
1179 extern int pager_use_color;
1180 extern int term_columns(void);
1181
1182 extern const char *editor_program;
1183 extern const char *askpass_program;
1184 extern const char *excludes_file;
1185
1186 /* base85 */
1187 int decode_85(char *dst, const char *line, int linelen);
1188 void encode_85(char *buf, const unsigned char *data, int bytes);
1189
1190 /* alloc.c */
1191 extern void *alloc_blob_node(void);
1192 extern void *alloc_tree_node(void);
1193 extern void *alloc_commit_node(void);
1194 extern void *alloc_tag_node(void);
1195 extern void *alloc_object_node(void);
1196 extern void alloc_report(void);
1197
1198 /* trace.c */
1199 __attribute__((format (printf, 1, 2)))
1200 extern void trace_printf(const char *format, ...);
1201 extern void trace_vprintf(const char *key, const char *format, va_list ap);
1202 __attribute__((format (printf, 2, 3)))
1203 extern void trace_argv_printf(const char **argv, const char *format, ...);
1204 extern void trace_repo_setup(const char *prefix);
1205 extern int trace_want(const char *key);
1206 extern void trace_strbuf(const char *key, const struct strbuf *buf);
1207
1208 void packet_trace_identity(const char *prog);
1209
1210 /* add */
1211 /*
1212  * return 0 if success, 1 - if addition of a file failed and
1213  * ADD_FILES_IGNORE_ERRORS was specified in flags
1214  */
1215 int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1216
1217 /* diff.c */
1218 extern int diff_auto_refresh_index;
1219
1220 /* match-trees.c */
1221 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1222 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1223
1224 /*
1225  * whitespace rules.
1226  * used by both diff and apply
1227  * last two digits are tab width
1228  */
1229 #define WS_BLANK_AT_EOL         0100
1230 #define WS_SPACE_BEFORE_TAB     0200
1231 #define WS_INDENT_WITH_NON_TAB  0400
1232 #define WS_CR_AT_EOL           01000
1233 #define WS_BLANK_AT_EOF        02000
1234 #define WS_TAB_IN_INDENT       04000
1235 #define WS_TRAILING_SPACE      (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1236 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1237 #define WS_TAB_WIDTH_MASK        077
1238 extern unsigned whitespace_rule_cfg;
1239 extern unsigned whitespace_rule(const char *);
1240 extern unsigned parse_whitespace_rule(const char *);
1241 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1242 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1243 extern char *whitespace_error_string(unsigned ws);
1244 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1245 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1246 #define ws_tab_width(rule)     ((rule) & WS_TAB_WIDTH_MASK)
1247
1248 /* ls-files */
1249 int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix);
1250 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1251
1252 char *alias_lookup(const char *alias);
1253 int split_cmdline(char *cmdline, const char ***argv);
1254 /* Takes a negative value returned by split_cmdline */
1255 const char *split_cmdline_strerror(int cmdline_errno);
1256
1257 /* git.c */
1258 struct startup_info {
1259         int have_repository;
1260         const char *prefix;
1261 };
1262 extern struct startup_info *startup_info;
1263
1264 /* builtin/merge.c */
1265 int checkout_fast_forward(const unsigned char *from, const unsigned char *to);
1266
1267 #endif /* CACHE_H */