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