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