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