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