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