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