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