cache.h

   1 #ifndef CACHE_H
   2 #define CACHE_H
   3
   4 #include "git-compat-util.h"
   5 #include "strbuf.h"
   6 #include "hashmap.h"
   7 #include "advice.h"
   8 #include "gettext.h"
   9 #include "convert.h"
  10 #include "trace.h"
  11 #include "string-list.h"
  12
  13 #include SHA1_HEADER
  14 #ifndef git_SHA_CTX
  15 #define git_SHA_CTX     SHA_CTX
  16 #define git_SHA1_Init   SHA1_Init
  17 #define git_SHA1_Update SHA1_Update
  18 #define git_SHA1_Final  SHA1_Final
  19 #endif
  20
  21 #include <zlib.h>
  22 typedef struct git_zstream {
  23         z_stream z;
  24         unsigned long avail_in;
  25         unsigned long avail_out;
  26         unsigned long total_in;
  27         unsigned long total_out;
  28         unsigned char *next_in;
  29         unsigned char *next_out;
  30 } git_zstream;
  31
  32 void git_inflate_init(git_zstream *);
  33 void git_inflate_init_gzip_only(git_zstream *);
  34 void git_inflate_end(git_zstream *);
  35 int git_inflate(git_zstream *, int flush);
  36
  37 void git_deflate_init(git_zstream *, int level);
  38 void git_deflate_init_gzip(git_zstream *, int level);
  39 void git_deflate_init_raw(git_zstream *, int level);
  40 void git_deflate_end(git_zstream *);
  41 int git_deflate_abort(git_zstream *);
  42 int git_deflate_end_gently(git_zstream *);
  43 int git_deflate(git_zstream *, int flush);
  44 unsigned long git_deflate_bound(git_zstream *, unsigned long);
  45
  46 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
  47 #define DTYPE(de)       ((de)->d_type)
  48 #else
  49 #undef DT_UNKNOWN
  50 #undef DT_DIR
  51 #undef DT_REG
  52 #undef DT_LNK
  53 #define DT_UNKNOWN      0
  54 #define DT_DIR          1
  55 #define DT_REG          2
  56 #define DT_LNK          3
  57 #define DTYPE(de)       DT_UNKNOWN
  58 #endif
  59
  60 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
  61 #define S_IFINVALID     0030000
  62
  63 /*
  64  * A "directory link" is a link to another git directory.
  65  *
  66  * The value 0160000 is not normally a valid mode, and
  67  * also just happens to be S_IFDIR + S_IFLNK
  68  */
  69 #define S_IFGITLINK     0160000
  70 #define S_ISGITLINK(m)  (((m) & S_IFMT) == S_IFGITLINK)
  71
  72 /*
  73  * Some mode bits are also used internally for computations.
  74  *
  75  * They *must* not overlap with any valid modes, and they *must* not be emitted
  76  * to outside world - i.e. appear on disk or network. In other words, it's just
  77  * temporary fields, which we internally use, but they have to stay in-house.
  78  *
  79  * ( such approach is valid, as standard S_IF* fits into 16 bits, and in Git
  80  *   codebase mode is `unsigned int` which is assumed to be at least 32 bits )
  81  */
  82
  83 /* used internally in tree-diff */
  84 #define S_DIFFTREE_IFXMIN_NEQ   0x80000000
  85
  86
  87 /*
  88  * Intensive research over the course of many years has shown that
  89  * port 9418 is totally unused by anything else. Or
  90  *
  91  *      Your search - "port 9418" - did not match any documents.
  92  *
  93  * as www.google.com puts it.
  94  *
  95  * This port has been properly assigned for git use by IANA:
  96  * git (Assigned-9418) [I06-050728-0001].
  97  *
  98  *      git  9418/tcp   git pack transfer service
  99  *      git  9418/udp   git pack transfer service
 100  *
 101  * with Linus Torvalds <torvalds@osdl.org> as the point of
 102  * contact. September 2005.
 103  *
 104  * See http://www.iana.org/assignments/port-numbers
 105  */
 106 #define DEFAULT_GIT_PORT 9418
 107
 108 /*
 109  * Basic data structures for the directory cache
 110  */
 111
 112 #define CACHE_SIGNATURE 0x44495243      /* "DIRC" */
 113 struct cache_header {
 114         uint32_t hdr_signature;
 115         uint32_t hdr_version;
 116         uint32_t hdr_entries;
 117 };
 118
 119 #define INDEX_FORMAT_LB 2
 120 #define INDEX_FORMAT_UB 4
 121
 122 /*
 123  * The "cache_time" is just the low 32 bits of the
 124  * time. It doesn't matter if it overflows - we only
 125  * check it for equality in the 32 bits we save.
 126  */
 127 struct cache_time {
 128         uint32_t sec;
 129         uint32_t nsec;
 130 };
 131
 132 struct stat_data {
 133         struct cache_time sd_ctime;
 134         struct cache_time sd_mtime;
 135         unsigned int sd_dev;
 136         unsigned int sd_ino;
 137         unsigned int sd_uid;
 138         unsigned int sd_gid;
 139         unsigned int sd_size;
 140 };
 141
 142 struct cache_entry {
 143         struct hashmap_entry ent;
 144         struct stat_data ce_stat_data;
 145         unsigned int ce_mode;
 146         unsigned int ce_flags;
 147         unsigned int ce_namelen;
 148         unsigned int index;     /* for link extension */
 149         unsigned char sha1[20];
 150         char name[FLEX_ARRAY]; /* more */
 151 };
 152
 153 #define CE_STAGEMASK (0x3000)
 154 #define CE_EXTENDED  (0x4000)
 155 #define CE_VALID     (0x8000)
 156 #define CE_STAGESHIFT 12
 157
 158 /*
 159  * Range 0xFFFF0FFF in ce_flags is divided into
 160  * two parts: in-memory flags and on-disk ones.
 161  * Flags in CE_EXTENDED_FLAGS will get saved on-disk
 162  * if you want to save a new flag, add it in
 163  * CE_EXTENDED_FLAGS
 164  *
 165  * In-memory only flags
 166  */
 167 #define CE_UPDATE            (1 << 16)
 168 #define CE_REMOVE            (1 << 17)
 169 #define CE_UPTODATE          (1 << 18)
 170 #define CE_ADDED             (1 << 19)
 171
 172 #define CE_HASHED            (1 << 20)
 173 #define CE_WT_REMOVE         (1 << 22) /* remove in work directory */
 174 #define CE_CONFLICTED        (1 << 23)
 175
 176 #define CE_UNPACKED          (1 << 24)
 177 #define CE_NEW_SKIP_WORKTREE (1 << 25)
 178
 179 /* used to temporarily mark paths matched by pathspecs */
 180 #define CE_MATCHED           (1 << 26)
 181
 182 #define CE_UPDATE_IN_BASE    (1 << 27)
 183 #define CE_STRIP_NAME        (1 << 28)
 184
 185 /*
 186  * Extended on-disk flags
 187  */
 188 #define CE_INTENT_TO_ADD     (1 << 29)
 189 #define CE_SKIP_WORKTREE     (1 << 30)
 190 /* CE_EXTENDED2 is for future extension */
 191 #define CE_EXTENDED2         (1 << 31)
 192
 193 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
 194
 195 /*
 196  * Safeguard to avoid saving wrong flags:
 197  *  - CE_EXTENDED2 won't get saved until its semantic is known
 198  *  - Bits in 0x0000FFFF have been saved in ce_flags already
 199  *  - Bits in 0x003F0000 are currently in-memory flags
 200  */
 201 #if CE_EXTENDED_FLAGS & 0x803FFFFF
 202 #error "CE_EXTENDED_FLAGS out of range"
 203 #endif
 204
 205 struct pathspec;
 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 static inline void copy_cache_entry(struct cache_entry *dst,
 212                                     const struct cache_entry *src)
 213 {
 214         unsigned int state = dst->ce_flags & CE_HASHED;
 215
 216         /* Don't copy hash chain and name */
 217         memcpy(&dst->ce_stat_data, &src->ce_stat_data,
 218                         offsetof(struct cache_entry, name) -
 219                         offsetof(struct cache_entry, ce_stat_data));
 220
 221         /* Restore the hash state */
 222         dst->ce_flags = (dst->ce_flags & ~CE_HASHED) | state;
 223 }
 224
 225 static inline unsigned create_ce_flags(unsigned stage)
 226 {
 227         return (stage << CE_STAGESHIFT);
 228 }
 229
 230 #define ce_namelen(ce) ((ce)->ce_namelen)
 231 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
 232 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
 233 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
 234 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
 235 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
 236
 237 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
 238 static inline unsigned int create_ce_mode(unsigned int mode)
 239 {
 240         if (S_ISLNK(mode))
 241                 return S_IFLNK;
 242         if (S_ISDIR(mode) || S_ISGITLINK(mode))
 243                 return S_IFGITLINK;
 244         return S_IFREG | ce_permissions(mode);
 245 }
 246 static inline unsigned int ce_mode_from_stat(const struct cache_entry *ce,
 247                                              unsigned int mode)
 248 {
 249         extern int trust_executable_bit, has_symlinks;
 250         if (!has_symlinks && S_ISREG(mode) &&
 251             ce && S_ISLNK(ce->ce_mode))
 252                 return ce->ce_mode;
 253         if (!trust_executable_bit && S_ISREG(mode)) {
 254                 if (ce && S_ISREG(ce->ce_mode))
 255                         return ce->ce_mode;
 256                 return create_ce_mode(0666);
 257         }
 258         return create_ce_mode(mode);
 259 }
 260 static inline int ce_to_dtype(const struct cache_entry *ce)
 261 {
 262         unsigned ce_mode = ntohl(ce->ce_mode);
 263         if (S_ISREG(ce_mode))
 264                 return DT_REG;
 265         else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
 266                 return DT_DIR;
 267         else if (S_ISLNK(ce_mode))
 268                 return DT_LNK;
 269         else
 270                 return DT_UNKNOWN;
 271 }
 272 static inline unsigned int canon_mode(unsigned int mode)
 273 {
 274         if (S_ISREG(mode))
 275                 return S_IFREG | ce_permissions(mode);
 276         if (S_ISLNK(mode))
 277                 return S_IFLNK;
 278         if (S_ISDIR(mode))
 279                 return S_IFDIR;
 280         return S_IFGITLINK;
 281 }
 282
 283 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
 284
 285 #define SOMETHING_CHANGED       (1 << 0) /* unclassified changes go here */
 286 #define CE_ENTRY_CHANGED        (1 << 1)
 287 #define CE_ENTRY_REMOVED        (1 << 2)
 288 #define CE_ENTRY_ADDED          (1 << 3)
 289 #define RESOLVE_UNDO_CHANGED    (1 << 4)
 290 #define CACHE_TREE_CHANGED      (1 << 5)
 291 #define SPLIT_INDEX_ORDERED     (1 << 6)
 292
 293 struct split_index;
 294 struct index_state {
 295         struct cache_entry **cache;
 296         unsigned int version;
 297         unsigned int cache_nr, cache_alloc, cache_changed;
 298         struct string_list *resolve_undo;
 299         struct cache_tree *cache_tree;
 300         struct split_index *split_index;
 301         struct cache_time timestamp;
 302         unsigned name_hash_initialized : 1,
 303                  initialized : 1;
 304         struct hashmap name_hash;
 305         struct hashmap dir_hash;
 306         unsigned char sha1[20];
 307 };
 308
 309 extern struct index_state the_index;
 310
 311 /* Name hashing */
 312 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
 313 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
 314 extern void free_name_hash(struct index_state *istate);
 315
 316
 317 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
 318 #define active_cache (the_index.cache)
 319 #define active_nr (the_index.cache_nr)
 320 #define active_alloc (the_index.cache_alloc)
 321 #define active_cache_changed (the_index.cache_changed)
 322 #define active_cache_tree (the_index.cache_tree)
 323
 324 #define read_cache() read_index(&the_index)
 325 #define read_cache_from(path) read_index_from(&the_index, (path))
 326 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
 327 #define is_cache_unborn() is_index_unborn(&the_index)
 328 #define read_cache_unmerged() read_index_unmerged(&the_index)
 329 #define discard_cache() discard_index(&the_index)
 330 #define unmerged_cache() unmerged_index(&the_index)
 331 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
 332 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
 333 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
 334 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
 335 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
 336 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
 337 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
 338 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
 339 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
 340 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
 341 #define cache_dir_exists(name, namelen) index_dir_exists(&the_index, (name), (namelen))
 342 #define cache_file_exists(name, namelen, igncase) index_file_exists(&the_index, (name), (namelen), (igncase))
 343 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
 344 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
 345 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
 346 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
 347 #define read_blob_data_from_cache(path, sz) read_blob_data_from_index(&the_index, (path), (sz))
 348 #endif
 349
 350 enum object_type {
 351         OBJ_BAD = -1,
 352         OBJ_NONE = 0,
 353         OBJ_COMMIT = 1,
 354         OBJ_TREE = 2,
 355         OBJ_BLOB = 3,
 356         OBJ_TAG = 4,
 357         /* 5 for future expansion */
 358         OBJ_OFS_DELTA = 6,
 359         OBJ_REF_DELTA = 7,
 360         OBJ_ANY,
 361         OBJ_MAX
 362 };
 363
 364 static inline enum object_type object_type(unsigned int mode)
 365 {
 366         return S_ISDIR(mode) ? OBJ_TREE :
 367                 S_ISGITLINK(mode) ? OBJ_COMMIT :
 368                 OBJ_BLOB;
 369 }
 370
 371 /* Double-check local_repo_env below if you add to this list. */
 372 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
 373 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
 374 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
 375 #define GIT_PREFIX_ENVIRONMENT "GIT_PREFIX"
 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 GIT_SHALLOW_FILE_ENVIRONMENT "GIT_SHALLOW_FILE"
 381 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
 382 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
 383 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
 384 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
 385 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
 386 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
 387 #define GITATTRIBUTES_FILE ".gitattributes"
 388 #define INFOATTRIBUTES_FILE "info/attributes"
 389 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
 390 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
 391 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
 392 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
 393 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
 394 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
 395 #define GIT_LITERAL_PATHSPECS_ENVIRONMENT "GIT_LITERAL_PATHSPECS"
 396 #define GIT_GLOB_PATHSPECS_ENVIRONMENT "GIT_GLOB_PATHSPECS"
 397 #define GIT_NOGLOB_PATHSPECS_ENVIRONMENT "GIT_NOGLOB_PATHSPECS"
 398 #define GIT_ICASE_PATHSPECS_ENVIRONMENT "GIT_ICASE_PATHSPECS"
 399
 400 /*
 401  * This environment variable is expected to contain a boolean indicating
 402  * whether we should or should not treat:
 403  *
 404  *   GIT_DIR=foo.git git ...
 405  *
 406  * as if GIT_WORK_TREE=. was given. It's not expected that users will make use
 407  * of this, but we use it internally to communicate to sub-processes that we
 408  * are in a bare repo. If not set, defaults to true.
 409  */
 410 #define GIT_IMPLICIT_WORK_TREE_ENVIRONMENT "GIT_IMPLICIT_WORK_TREE"
 411
 412 /*
 413  * Repository-local GIT_* environment variables; these will be cleared
 414  * when git spawns a sub-process that runs inside another repository.
 415  * The array is NULL-terminated, which makes it easy to pass in the "env"
 416  * parameter of a run-command invocation, or to do a simple walk.
 417  */
 418 extern const char * const local_repo_env[];
 419
 420 extern int is_bare_repository_cfg;
 421 extern int is_bare_repository(void);
 422 extern int is_inside_git_dir(void);
 423 extern char *git_work_tree_cfg;
 424 extern int is_inside_work_tree(void);
 425 extern const char *get_git_dir(void);
 426 extern int is_git_directory(const char *path);
 427 extern char *get_object_directory(void);
 428 extern char *get_index_file(void);
 429 extern char *get_graft_file(void);
 430 extern int set_git_dir(const char *path);
 431 extern const char *get_git_namespace(void);
 432 extern const char *strip_namespace(const char *namespaced_ref);
 433 extern const char *get_git_work_tree(void);
 434 extern const char *read_gitfile(const char *path);
 435 extern const char *resolve_gitdir(const char *suspect);
 436 extern void set_git_work_tree(const char *tree);
 437
 438 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
 439
 440 extern const char **get_pathspec(const char *prefix, const char **pathspec);
 441 extern void setup_work_tree(void);
 442 extern const char *setup_git_directory_gently(int *);
 443 extern const char *setup_git_directory(void);
 444 extern char *prefix_path(const char *prefix, int len, const char *path);
 445 extern char *prefix_path_gently(const char *prefix, int len, int *remaining, const char *path);
 446 extern const char *prefix_filename(const char *prefix, int len, const char *path);
 447 extern int check_filename(const char *prefix, const char *name);
 448 extern void verify_filename(const char *prefix,
 449                             const char *name,
 450                             int diagnose_misspelt_rev);
 451 extern void verify_non_filename(const char *prefix, const char *name);
 452 extern int path_inside_repo(const char *prefix, const char *path);
 453
 454 #define INIT_DB_QUIET 0x0001
 455
 456 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
 457 extern int init_db(const char *template_dir, unsigned int flags);
 458
 459 extern void sanitize_stdfds(void);
 460 extern int daemonize(void);
 461
 462 #define alloc_nr(x) (((x)+16)*3/2)
 463
 464 /*
 465  * Realloc the buffer pointed at by variable 'x' so that it can hold
 466  * at least 'nr' entries; the number of entries currently allocated
 467  * is 'alloc', using the standard growing factor alloc_nr() macro.
 468  *
 469  * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
 470  */
 471 #define ALLOC_GROW(x, nr, alloc) \
 472         do { \
 473                 if ((nr) > alloc) { \
 474                         if (alloc_nr(alloc) < (nr)) \
 475                                 alloc = (nr); \
 476                         else \
 477                                 alloc = alloc_nr(alloc); \
 478                         REALLOC_ARRAY(x, alloc); \
 479                 } \
 480         } while (0)
 481
 482 /* Initialize and use the cache information */
 483 struct lock_file;
 484 extern int read_index(struct index_state *);
 485 extern int read_index_preload(struct index_state *, const struct pathspec *pathspec);
 486 extern int do_read_index(struct index_state *istate, const char *path,
 487                          int must_exist); /* for testting only! */
 488 extern int read_index_from(struct index_state *, const char *path);
 489 extern int is_index_unborn(struct index_state *);
 490 extern int read_index_unmerged(struct index_state *);
 491 #define COMMIT_LOCK             (1 << 0)
 492 #define CLOSE_LOCK              (1 << 1)
 493 extern int write_locked_index(struct index_state *, struct lock_file *lock, unsigned flags);
 494 extern int discard_index(struct index_state *);
 495 extern int unmerged_index(const struct index_state *);
 496 extern int verify_path(const char *path);
 497 extern struct cache_entry *index_dir_exists(struct index_state *istate, const char *name, int namelen);
 498 extern struct cache_entry *index_file_exists(struct index_state *istate, const char *name, int namelen, int igncase);
 499 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
 500 #define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
 501 #define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
 502 #define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
 503 #define ADD_CACHE_JUST_APPEND 8         /* Append only; tree.c::read_tree() */
 504 #define ADD_CACHE_NEW_ONLY 16           /* Do not replace existing ones */
 505 #define ADD_CACHE_KEEP_CACHE_TREE 32    /* Do not invalidate cache-tree */
 506 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
 507 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
 508 extern int remove_index_entry_at(struct index_state *, int pos);
 509 extern void remove_marked_cache_entries(struct index_state *istate);
 510 extern int remove_file_from_index(struct index_state *, const char *path);
 511 #define ADD_CACHE_VERBOSE 1
 512 #define ADD_CACHE_PRETEND 2
 513 #define ADD_CACHE_IGNORE_ERRORS 4
 514 #define ADD_CACHE_IGNORE_REMOVAL 8
 515 #define ADD_CACHE_INTENT 16
 516 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
 517 extern int add_file_to_index(struct index_state *, const char *path, int flags);
 518 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, unsigned int refresh_options);
 519 extern int ce_same_name(const struct cache_entry *a, const struct cache_entry *b);
 520 extern void set_object_name_for_intent_to_add_entry(struct cache_entry *ce);
 521 extern int index_name_is_other(const struct index_state *, const char *, int);
 522 extern void *read_blob_data_from_index(struct index_state *, const char *, unsigned long *);
 523
 524 /* do stat comparison even if CE_VALID is true */
 525 #define CE_MATCH_IGNORE_VALID           01
 526 /* do not check the contents but report dirty on racily-clean entries */
 527 #define CE_MATCH_RACY_IS_DIRTY          02
 528 /* do stat comparison even if CE_SKIP_WORKTREE is true */
 529 #define CE_MATCH_IGNORE_SKIP_WORKTREE   04
 530 /* ignore non-existent files during stat update  */
 531 #define CE_MATCH_IGNORE_MISSING         0x08
 532 /* enable stat refresh */
 533 #define CE_MATCH_REFRESH                0x10
 534 extern int ie_match_stat(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
 535 extern int ie_modified(const struct index_state *, const struct cache_entry *, struct stat *, unsigned int);
 536
 537 #define HASH_WRITE_OBJECT 1
 538 #define HASH_FORMAT_CHECK 2
 539 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
 540 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
 541
 542 /*
 543  * Record to sd the data from st that we use to check whether a file
 544  * might have changed.
 545  */
 546 extern void fill_stat_data(struct stat_data *sd, struct stat *st);
 547
 548 /*
 549  * Return 0 if st is consistent with a file not having been changed
 550  * since sd was filled.  If there are differences, return a
 551  * combination of MTIME_CHANGED, CTIME_CHANGED, OWNER_CHANGED,
 552  * INODE_CHANGED, and DATA_CHANGED.
 553  */
 554 extern int match_stat_data(const struct stat_data *sd, struct stat *st);
 555
 556 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
 557
 558 #define REFRESH_REALLY          0x0001  /* ignore_valid */
 559 #define REFRESH_UNMERGED        0x0002  /* allow unmerged */
 560 #define REFRESH_QUIET           0x0004  /* be quiet about it */
 561 #define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
 562 #define REFRESH_IGNORE_SUBMODULES       0x0010  /* ignore submodules */
 563 #define REFRESH_IN_PORCELAIN    0x0020  /* user friendly output, not "needs update" */
 564 extern int refresh_index(struct index_state *, unsigned int flags, const struct pathspec *pathspec, char *seen, const char *header_msg);
 565
 566 extern void update_index_if_able(struct index_state *, struct lock_file *);
 567
 568 extern int hold_locked_index(struct lock_file *, int);
 569 extern void set_alternate_index_output(const char *);
 570
 571 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
 572
 573 /* Environment bits from configuration mechanism */
 574 extern int trust_executable_bit;
 575 extern int trust_ctime;
 576 extern int check_stat;
 577 extern int quote_path_fully;
 578 extern int has_symlinks;
 579 extern int minimum_abbrev, default_abbrev;
 580 extern int ignore_case;
 581 extern int assume_unchanged;
 582 extern int prefer_symlink_refs;
 583 extern int log_all_ref_updates;
 584 extern int warn_ambiguous_refs;
 585 extern int warn_on_object_refname_ambiguity;
 586 extern int shared_repository;
 587 extern const char *apply_default_whitespace;
 588 extern const char *apply_default_ignorewhitespace;
 589 extern const char *git_attributes_file;
 590 extern int zlib_compression_level;
 591 extern int core_compression_level;
 592 extern int core_compression_seen;
 593 extern size_t packed_git_window_size;
 594 extern size_t packed_git_limit;
 595 extern size_t delta_base_cache_limit;
 596 extern unsigned long big_file_threshold;
 597 extern unsigned long pack_size_limit_cfg;
 598
 599 /*
 600  * Do replace refs need to be checked this run?  This variable is
 601  * initialized to true unless --no-replace-object is used or
 602  * $GIT_NO_REPLACE_OBJECTS is set, but is set to false by some
 603  * commands that do not want replace references to be active.  As an
 604  * optimization it is also set to false if replace references have
 605  * been sought but there were none.
 606  */
 607 extern int check_replace_refs;
 608
 609 extern int fsync_object_files;
 610 extern int core_preload_index;
 611 extern int core_apply_sparse_checkout;
 612 extern int precomposed_unicode;
 613 extern int protect_hfs;
 614 extern int protect_ntfs;
 615
 616 /*
 617  * The character that begins a commented line in user-editable file
 618  * that is subject to stripspace.
 619  */
 620 extern char comment_line_char;
 621 extern int auto_comment_line_char;
 622
 623 enum branch_track {
 624         BRANCH_TRACK_UNSPECIFIED = -1,
 625         BRANCH_TRACK_NEVER = 0,
 626         BRANCH_TRACK_REMOTE,
 627         BRANCH_TRACK_ALWAYS,
 628         BRANCH_TRACK_EXPLICIT,
 629         BRANCH_TRACK_OVERRIDE
 630 };
 631
 632 enum rebase_setup_type {
 633         AUTOREBASE_NEVER = 0,
 634         AUTOREBASE_LOCAL,
 635         AUTOREBASE_REMOTE,
 636         AUTOREBASE_ALWAYS
 637 };
 638
 639 enum push_default_type {
 640         PUSH_DEFAULT_NOTHING = 0,
 641         PUSH_DEFAULT_MATCHING,
 642         PUSH_DEFAULT_SIMPLE,
 643         PUSH_DEFAULT_UPSTREAM,
 644         PUSH_DEFAULT_CURRENT,
 645         PUSH_DEFAULT_UNSPECIFIED
 646 };
 647
 648 extern enum branch_track git_branch_track;
 649 extern enum rebase_setup_type autorebase;
 650 extern enum push_default_type push_default;
 651
 652 enum object_creation_mode {
 653         OBJECT_CREATION_USES_HARDLINKS = 0,
 654         OBJECT_CREATION_USES_RENAMES = 1
 655 };
 656
 657 extern enum object_creation_mode object_creation_mode;
 658
 659 extern char *notes_ref_name;
 660
 661 extern int grafts_replace_parents;
 662
 663 #define GIT_REPO_VERSION 0
 664 extern int repository_format_version;
 665 extern int check_repository_format(void);
 666
 667 #define MTIME_CHANGED   0x0001
 668 #define CTIME_CHANGED   0x0002
 669 #define OWNER_CHANGED   0x0004
 670 #define MODE_CHANGED    0x0008
 671 #define INODE_CHANGED   0x0010
 672 #define DATA_CHANGED    0x0020
 673 #define TYPE_CHANGED    0x0040
 674
 675 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
 676         __attribute__((format (printf, 3, 4)));
 677 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
 678         __attribute__((format (printf, 3, 4)));
 679 extern char *git_pathdup(const char *fmt, ...)
 680         __attribute__((format (printf, 1, 2)));
 681 extern char *mkpathdup(const char *fmt, ...)
 682         __attribute__((format (printf, 1, 2)));
 683
 684 /* Return a statically allocated filename matching the sha1 signature */
 685 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 686 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 687 extern char *git_path_submodule(const char *path, const char *fmt, ...)
 688         __attribute__((format (printf, 2, 3)));
 689
 690 /*
 691  * Return the name of the file in the local object database that would
 692  * be used to store a loose object with the specified sha1.  The
 693  * return value is a pointer to a statically allocated buffer that is
 694  * overwritten each time the function is called.
 695  */
 696 extern const char *sha1_file_name(const unsigned char *sha1);
 697
 698 /*
 699  * Return the name of the (local) packfile with the specified sha1 in
 700  * its name.  The return value is a pointer to memory that is
 701  * overwritten each time this function is called.
 702  */
 703 extern char *sha1_pack_name(const unsigned char *sha1);
 704
 705 /*
 706  * Return the name of the (local) pack index file with the specified
 707  * sha1 in its name.  The return value is a pointer to memory that is
 708  * overwritten each time this function is called.
 709  */
 710 extern char *sha1_pack_index_name(const unsigned char *sha1);
 711
 712 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
 713 extern const unsigned char null_sha1[20];
 714
 715 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
 716 {
 717         int i;
 718
 719         for (i = 0; i < 20; i++, sha1++, sha2++) {
 720                 if (*sha1 != *sha2)
 721                         return *sha1 - *sha2;
 722         }
 723
 724         return 0;
 725 }
 726
 727 static inline int is_null_sha1(const unsigned char *sha1)
 728 {
 729         return !hashcmp(sha1, null_sha1);
 730 }
 731
 732 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
 733 {
 734         memcpy(sha_dst, sha_src, 20);
 735 }
 736 static inline void hashclr(unsigned char *hash)
 737 {
 738         memset(hash, 0, 20);
 739 }
 740
 741 #define EMPTY_TREE_SHA1_HEX \
 742         "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
 743 #define EMPTY_TREE_SHA1_BIN_LITERAL \
 744          "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
 745          "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
 746 #define EMPTY_TREE_SHA1_BIN \
 747          ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
 748
 749 #define EMPTY_BLOB_SHA1_HEX \
 750         "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
 751 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
 752         "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
 753         "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
 754 #define EMPTY_BLOB_SHA1_BIN \
 755         ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
 756
 757 static inline int is_empty_blob_sha1(const unsigned char *sha1)
 758 {
 759         return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
 760 }
 761
 762 int git_mkstemp(char *path, size_t n, const char *template);
 763
 764 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
 765
 766 /* set default permissions by passing mode arguments to open(2) */
 767 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
 768 int git_mkstemp_mode(char *pattern, int mode);
 769
 770 /*
 771  * NOTE NOTE NOTE!!
 772  *
 773  * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
 774  * not be changed. Old repositories have core.sharedrepository written in
 775  * numeric format, and therefore these values are preserved for compatibility
 776  * reasons.
 777  */
 778 enum sharedrepo {
 779         PERM_UMASK          = 0,
 780         OLD_PERM_GROUP      = 1,
 781         OLD_PERM_EVERYBODY  = 2,
 782         PERM_GROUP          = 0660,
 783         PERM_EVERYBODY      = 0664
 784 };
 785 int git_config_perm(const char *var, const char *value);
 786 int adjust_shared_perm(const char *path);
 787
 788 /*
 789  * Create the directory containing the named path, using care to be
 790  * somewhat safe against races.  Return one of the scld_error values
 791  * to indicate success/failure.
 792  *
 793  * SCLD_VANISHED indicates that one of the ancestor directories of the
 794  * path existed at one point during the function call and then
 795  * suddenly vanished, probably because another process pruned the
 796  * directory while we were working.  To be robust against this kind of
 797  * race, callers might want to try invoking the function again when it
 798  * returns SCLD_VANISHED.
 799  */
 800 enum scld_error {
 801         SCLD_OK = 0,
 802         SCLD_FAILED = -1,
 803         SCLD_PERMS = -2,
 804         SCLD_EXISTS = -3,
 805         SCLD_VANISHED = -4
 806 };
 807 enum scld_error safe_create_leading_directories(char *path);
 808 enum scld_error safe_create_leading_directories_const(const char *path);
 809
 810 int mkdir_in_gitdir(const char *path);
 811 extern void home_config_paths(char **global, char **xdg, char *file);
 812 extern char *expand_user_path(const char *path);
 813 const char *enter_repo(const char *path, int strict);
 814 static inline int is_absolute_path(const char *path)
 815 {
 816         return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
 817 }
 818 int is_directory(const char *);
 819 const char *real_path(const char *path);
 820 const char *real_path_if_valid(const char *path);
 821 const char *absolute_path(const char *path);
 822 const char *remove_leading_path(const char *in, const char *prefix);
 823 const char *relative_path(const char *in, const char *prefix, struct strbuf *sb);
 824 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len);
 825 int normalize_path_copy(char *dst, const char *src);
 826 int longest_ancestor_length(const char *path, struct string_list *prefixes);
 827 char *strip_path_suffix(const char *path, const char *suffix);
 828 int daemon_avoid_alias(const char *path);
 829 extern int is_ntfs_dotgit(const char *name);
 830
 831 /* object replacement */
 832 #define LOOKUP_REPLACE_OBJECT 1
 833 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
 834 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
 835 {
 836         return read_sha1_file_extended(sha1, type, size, LOOKUP_REPLACE_OBJECT);
 837 }
 838
 839 /*
 840  * This internal function is only declared here for the benefit of
 841  * lookup_replace_object().  Please do not call it directly.
 842  */
 843 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
 844
 845 /*
 846  * If object sha1 should be replaced, return the replacement object's
 847  * name (replaced recursively, if necessary).  The return value is
 848  * either sha1 or a pointer to a permanently-allocated value.  When
 849  * object replacement is suppressed, always return sha1.
 850  */
 851 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
 852 {
 853         if (!check_replace_refs)
 854                 return sha1;
 855         return do_lookup_replace_object(sha1);
 856 }
 857
 858 static inline const unsigned char *lookup_replace_object_extended(const unsigned char *sha1, unsigned flag)
 859 {
 860         if (!(flag & LOOKUP_REPLACE_OBJECT))
 861                 return sha1;
 862         return lookup_replace_object(sha1);
 863 }
 864
 865 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
 866 extern int sha1_object_info(const unsigned char *, unsigned long *);
 867 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
 868 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
 869 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
 870 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
 871 extern int git_open_noatime(const char *name);
 872 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
 873 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
 874 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
 875
 876 /* global flag to enable extra checks when accessing packed objects */
 877 extern int do_check_packed_object_crc;
 878
 879 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
 880
 881 extern int move_temp_to_file(const char *tmpfile, const char *filename);
 882
 883 extern int has_sha1_pack(const unsigned char *sha1);
 884
 885 /*
 886  * Return true iff we have an object named sha1, whether local or in
 887  * an alternate object database, and whether packed or loose.  This
 888  * function does not respect replace references.
 889  */
 890 extern int has_sha1_file(const unsigned char *sha1);
 891
 892 /*
 893  * Return true iff an alternate object database has a loose object
 894  * with the specified name.  This function does not respect replace
 895  * references.
 896  */
 897 extern int has_loose_object_nonlocal(const unsigned char *sha1);
 898
 899 extern int has_pack_index(const unsigned char *sha1);
 900
 901 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
 902
 903 extern const signed char hexval_table[256];
 904 static inline unsigned int hexval(unsigned char c)
 905 {
 906         return hexval_table[c];
 907 }
 908
 909 /* Convert to/from hex/sha1 representation */
 910 #define MINIMUM_ABBREV minimum_abbrev
 911 #define DEFAULT_ABBREV default_abbrev
 912
 913 struct object_context {
 914         unsigned char tree[20];
 915         char path[PATH_MAX];
 916         unsigned mode;
 917 };
 918
 919 #define GET_SHA1_QUIETLY        01
 920 #define GET_SHA1_COMMIT         02
 921 #define GET_SHA1_COMMITTISH     04
 922 #define GET_SHA1_TREE          010
 923 #define GET_SHA1_TREEISH       020
 924 #define GET_SHA1_BLOB          040
 925 #define GET_SHA1_ONLY_TO_DIE 04000
 926
 927 extern int get_sha1(const char *str, unsigned char *sha1);
 928 extern int get_sha1_commit(const char *str, unsigned char *sha1);
 929 extern int get_sha1_committish(const char *str, unsigned char *sha1);
 930 extern int get_sha1_tree(const char *str, unsigned char *sha1);
 931 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
 932 extern int get_sha1_blob(const char *str, unsigned char *sha1);
 933 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
 934 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
 935
 936 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
 937 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
 938
 939 /*
 940  * Try to read a SHA1 in hexadecimal format from the 40 characters
 941  * starting at hex.  Write the 20-byte result to sha1 in binary form.
 942  * Return 0 on success.  Reading stops if a NUL is encountered in the
 943  * input, so it is safe to pass this function an arbitrary
 944  * null-terminated string.
 945  */
 946 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
 947
 948 extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
 949 extern int read_ref_full(const char *refname, int resolve_flags,
 950                          unsigned char *sha1, int *flags);
 951 extern int read_ref(const char *refname, unsigned char *sha1);
 952
 953 /*
 954  * Resolve a reference, recursively following symbolic refererences.
 955  *
 956  * Store the referred-to object's name in sha1 and return the name of
 957  * the non-symbolic reference that ultimately pointed at it.  The
 958  * return value, if not NULL, is a pointer into either a static buffer
 959  * or the input ref.
 960  *
 961  * If the reference cannot be resolved to an object, the behavior
 962  * depends on the RESOLVE_REF_READING flag:
 963  *
 964  * - If RESOLVE_REF_READING is set, return NULL.
 965  *
 966  * - If RESOLVE_REF_READING is not set, clear sha1 and return the name of
 967  *   the last reference name in the chain, which will either be a non-symbolic
 968  *   reference or an undefined reference.  If this is a prelude to
 969  *   "writing" to the ref, the return value is the name of the ref
 970  *   that will actually be created or changed.
 971  *
 972  * If the RESOLVE_REF_NO_RECURSE flag is passed, only resolves one
 973  * level of symbolic reference.  The value stored in sha1 for a symbolic
 974  * reference will always be null_sha1 in this case, and the return
 975  * value is the reference that the symref refers to directly.
 976  *
 977  * If flags is non-NULL, set the value that it points to the
 978  * combination of REF_ISPACKED (if the reference was found among the
 979  * packed references), REF_ISSYMREF (if the initial reference was a
 980  * symbolic reference), REF_BAD_NAME (if the reference name is ill
 981  * formed --- see RESOLVE_REF_ALLOW_BAD_NAME below), and REF_ISBROKEN
 982  * (if the ref is malformed or has a bad name). See refs.h for more detail
 983  * on each flag.
 984  *
 985  * If ref is not a properly-formatted, normalized reference, return
 986  * NULL.  If more than MAXDEPTH recursive symbolic lookups are needed,
 987  * give up and return NULL.
 988  *
 989  * RESOLVE_REF_ALLOW_BAD_NAME allows resolving refs even when their
 990  * name is invalid according to git-check-ref-format(1).  If the name
 991  * is bad then the value stored in sha1 will be null_sha1 and the two
 992  * flags REF_ISBROKEN and REF_BAD_NAME will be set.
 993  *
 994  * Even with RESOLVE_REF_ALLOW_BAD_NAME, names that escape the refs/
 995  * directory and do not consist of all caps and underscores cannot be
 996  * resolved. The function returns NULL for such ref names.
 997  * Caps and underscores refers to the special refs, such as HEAD,
 998  * FETCH_HEAD and friends, that all live outside of the refs/ directory.
 999  */
1000 #define RESOLVE_REF_READING 0x01
1001 #define RESOLVE_REF_NO_RECURSE 0x02
1002 #define RESOLVE_REF_ALLOW_BAD_NAME 0x04
1003 extern const char *resolve_ref_unsafe(const char *ref, int resolve_flags, unsigned char *sha1, int *flags);
1004 extern char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags);
1005
1006 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
1007 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
1008 extern int interpret_branch_name(const char *str, int len, struct strbuf *);
1009 extern int get_sha1_mb(const char *str, unsigned char *sha1);
1010
1011 /*
1012  * Return true iff abbrev_name is a possible abbreviation for
1013  * full_name according to the rules defined by ref_rev_parse_rules in
1014  * refs.c.
1015  */
1016 extern int refname_match(const char *abbrev_name, const char *full_name);
1017
1018 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
1019 extern int validate_headref(const char *ref);
1020
1021 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1022 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
1023 extern int name_compare(const char *name1, size_t len1, const char *name2, size_t len2);
1024 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
1025
1026 extern void *read_object_with_reference(const unsigned char *sha1,
1027                                         const char *required_type,
1028                                         unsigned long *size,
1029                                         unsigned char *sha1_ret);
1030
1031 extern struct object *peel_to_type(const char *name, int namelen,
1032                                    struct object *o, enum object_type);
1033
1034 enum date_mode {
1035         DATE_NORMAL = 0,
1036         DATE_RELATIVE,
1037         DATE_SHORT,
1038         DATE_LOCAL,
1039         DATE_ISO8601,
1040         DATE_ISO8601_STRICT,
1041         DATE_RFC2822,
1042         DATE_RAW
1043 };
1044
1045 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
1046 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
1047                         struct strbuf *timebuf);
1048 int parse_date(const char *date, struct strbuf *out);
1049 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
1050 int parse_expiry_date(const char *date, unsigned long *timestamp);
1051 void datestamp(struct strbuf *out);
1052 #define approxidate(s) approxidate_careful((s), NULL)
1053 unsigned long approxidate_careful(const char *, int *);
1054 unsigned long approxidate_relative(const char *date, const struct timeval *now);
1055 enum date_mode parse_date_format(const char *format);
1056 int date_overflows(unsigned long date);
1057
1058 #define IDENT_STRICT           1
1059 #define IDENT_NO_DATE          2
1060 #define IDENT_NO_NAME          4
1061 extern const char *git_author_info(int);
1062 extern const char *git_committer_info(int);
1063 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
1064 extern const char *fmt_name(const char *name, const char *email);
1065 extern const char *ident_default_name(void);
1066 extern const char *ident_default_email(void);
1067 extern const char *git_editor(void);
1068 extern const char *git_pager(int stdout_is_tty);
1069 extern int git_ident_config(const char *, const char *, void *);
1070
1071 struct ident_split {
1072         const char *name_begin;
1073         const char *name_end;
1074         const char *mail_begin;
1075         const char *mail_end;
1076         const char *date_begin;
1077         const char *date_end;
1078         const char *tz_begin;
1079         const char *tz_end;
1080 };
1081 /*
1082  * Signals an success with 0, but time part of the result may be NULL
1083  * if the input lacks timestamp and zone
1084  */
1085 extern int split_ident_line(struct ident_split *, const char *, int);
1086
1087 /*
1088  * Like show_date, but pull the timestamp and tz parameters from
1089  * the ident_split. It will also sanity-check the values and produce
1090  * a well-known sentinel date if they appear bogus.
1091  */
1092 const char *show_ident_date(const struct ident_split *id, enum date_mode mode);
1093
1094 /*
1095  * Compare split idents for equality or strict ordering. Note that we
1096  * compare only the ident part of the line, ignoring any timestamp.
1097  *
1098  * Because there are two fields, we must choose one as the primary key; we
1099  * currently arbitrarily pick the email.
1100  */
1101 extern int ident_cmp(const struct ident_split *, const struct ident_split *);
1102
1103 struct checkout {
1104         struct index_state *istate;
1105         const char *base_dir;
1106         int base_dir_len;
1107         unsigned force:1,
1108                  quiet:1,
1109                  not_new:1,
1110                  refresh_cache:1;
1111 };
1112
1113 #define TEMPORARY_FILENAME_LENGTH 25
1114 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
1115
1116 struct cache_def {
1117         struct strbuf path;
1118         int flags;
1119         int track_flags;
1120         int prefix_len_stat_func;
1121 };
1122 #define CACHE_DEF_INIT { STRBUF_INIT, 0, 0, 0 }
1123 static inline void cache_def_clear(struct cache_def *cache)
1124 {
1125         strbuf_release(&cache->path);
1126 }
1127
1128 extern int has_symlink_leading_path(const char *name, int len);
1129 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
1130 extern int check_leading_path(const char *name, int len);
1131 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
1132 extern void schedule_dir_for_removal(const char *name, int len);
1133 extern void remove_scheduled_dirs(void);
1134
1135 extern struct alternate_object_database {
1136         struct alternate_object_database *next;
1137         char *name;
1138         char base[FLEX_ARRAY]; /* more */
1139 } *alt_odb_list;
1140 extern void prepare_alt_odb(void);
1141 extern void read_info_alternates(const char * relative_base, int depth);
1142 extern void add_to_alternates_file(const char *reference);
1143 typedef int alt_odb_fn(struct alternate_object_database *, void *);
1144 extern int foreach_alt_odb(alt_odb_fn, void*);
1145
1146 struct pack_window {
1147         struct pack_window *next;
1148         unsigned char *base;
1149         off_t offset;
1150         size_t len;
1151         unsigned int last_used;
1152         unsigned int inuse_cnt;
1153 };
1154
1155 extern struct packed_git {
1156         struct packed_git *next;
1157         struct pack_window *windows;
1158         off_t pack_size;
1159         const void *index_data;
1160         size_t index_size;
1161         uint32_t num_objects;
1162         uint32_t num_bad_objects;
1163         unsigned char *bad_object_sha1;
1164         int index_version;
1165         time_t mtime;
1166         int pack_fd;
1167         unsigned pack_local:1,
1168                  pack_keep:1,
1169                  do_not_close:1;
1170         unsigned char sha1[20];
1171         /* something like ".git/objects/pack/xxxxx.pack" */
1172         char pack_name[FLEX_ARRAY]; /* more */
1173 } *packed_git;
1174
1175 struct pack_entry {
1176         off_t offset;
1177         unsigned char sha1[20];
1178         struct packed_git *p;
1179 };
1180
1181 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1182
1183 /* A hook for count-objects to report invalid files in pack directory */
1184 extern void (*report_garbage)(const char *desc, const char *path);
1185
1186 extern void prepare_packed_git(void);
1187 extern void reprepare_packed_git(void);
1188 extern void install_packed_git(struct packed_git *pack);
1189
1190 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1191                                          struct packed_git *packs);
1192
1193 extern void pack_report(void);
1194
1195 /*
1196  * mmap the index file for the specified packfile (if it is not
1197  * already mmapped).  Return 0 on success.
1198  */
1199 extern int open_pack_index(struct packed_git *);
1200
1201 /*
1202  * munmap the index file for the specified packfile (if it is
1203  * currently mmapped).
1204  */
1205 extern void close_pack_index(struct packed_git *);
1206
1207 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1208 extern void close_pack_windows(struct packed_git *);
1209 extern void unuse_pack(struct pack_window **);
1210 extern void free_pack_by_name(const char *);
1211 extern void clear_delta_base_cache(void);
1212 extern struct packed_git *add_packed_git(const char *, int, int);
1213
1214 /*
1215  * Return the SHA-1 of the nth object within the specified packfile.
1216  * Open the index if it is not already open.  The return value points
1217  * at the SHA-1 within the mmapped index.  Return NULL if there is an
1218  * error.
1219  */
1220 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t n);
1221
1222 /*
1223  * Return the offset of the nth object within the specified packfile.
1224  * The index must already be opened.
1225  */
1226 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t n);
1227
1228 /*
1229  * If the object named sha1 is present in the specified packfile,
1230  * return its offset within the packfile; otherwise, return 0.
1231  */
1232 extern off_t find_pack_entry_one(const unsigned char *sha1, struct packed_git *);
1233
1234 extern int is_pack_valid(struct packed_git *);
1235 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1236 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1237 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1238 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1239
1240 /*
1241  * Iterate over the files in the loose-object parts of the object
1242  * directory "path", triggering the following callbacks:
1243  *
1244  *  - loose_object is called for each loose object we find.
1245  *
1246  *  - loose_cruft is called for any files that do not appear to be
1247  *    loose objects. Note that we only look in the loose object
1248  *    directories "objects/[0-9a-f]{2}/", so we will not report
1249  *    "objects/foobar" as cruft.
1250  *
1251  *  - loose_subdir is called for each top-level hashed subdirectory
1252  *    of the object directory (e.g., "$OBJDIR/f0"). It is called
1253  *    after the objects in the directory are processed.
1254  *
1255  * Any callback that is NULL will be ignored. Callbacks returning non-zero
1256  * will end the iteration.
1257  *
1258  * In the "buf" variant, "path" is a strbuf which will also be used as a
1259  * scratch buffer, but restored to its original contents before
1260  * the function returns.
1261  */
1262 typedef int each_loose_object_fn(const unsigned char *sha1,
1263                                  const char *path,
1264                                  void *data);
1265 typedef int each_loose_cruft_fn(const char *basename,
1266                                 const char *path,
1267                                 void *data);
1268 typedef int each_loose_subdir_fn(int nr,
1269                                  const char *path,
1270                                  void *data);
1271 int for_each_loose_file_in_objdir(const char *path,
1272                                   each_loose_object_fn obj_cb,
1273                                   each_loose_cruft_fn cruft_cb,
1274                                   each_loose_subdir_fn subdir_cb,
1275                                   void *data);
1276 int for_each_loose_file_in_objdir_buf(struct strbuf *path,
1277                                       each_loose_object_fn obj_cb,
1278                                       each_loose_cruft_fn cruft_cb,
1279                                       each_loose_subdir_fn subdir_cb,
1280                                       void *data);
1281
1282 /*
1283  * Iterate over loose and packed objects in both the local
1284  * repository and any alternates repositories.
1285  */
1286 typedef int each_packed_object_fn(const unsigned char *sha1,
1287                                   struct packed_git *pack,
1288                                   uint32_t pos,
1289                                   void *data);
1290 extern int for_each_loose_object(each_loose_object_fn, void *);
1291 extern int for_each_packed_object(each_packed_object_fn, void *);
1292
1293 struct object_info {
1294         /* Request */
1295         enum object_type *typep;
1296         unsigned long *sizep;
1297         unsigned long *disk_sizep;
1298         unsigned char *delta_base_sha1;
1299
1300         /* Response */
1301         enum {
1302                 OI_CACHED,
1303                 OI_LOOSE,
1304                 OI_PACKED,
1305                 OI_DBCACHED
1306         } whence;
1307         union {
1308                 /*
1309                  * struct {
1310                  *      ... Nothing to expose in this case
1311                  * } cached;
1312                  * struct {
1313                  *      ... Nothing to expose in this case
1314                  * } loose;
1315                  */
1316                 struct {
1317                         struct packed_git *pack;
1318                         off_t offset;
1319                         unsigned int is_delta;
1320                 } packed;
1321         } u;
1322 };
1323 extern int sha1_object_info_extended(const unsigned char *, struct object_info *, unsigned flags);
1324
1325 /* Dumb servers support */
1326 extern int update_server_info(int);
1327
1328 /* git_config_parse_key() returns these negated: */
1329 #define CONFIG_INVALID_KEY 1
1330 #define CONFIG_NO_SECTION_OR_NAME 2
1331 /* git_config_set(), git_config_set_multivar() return the above or these: */
1332 #define CONFIG_NO_LOCK -1
1333 #define CONFIG_INVALID_FILE 3
1334 #define CONFIG_NO_WRITE 4
1335 #define CONFIG_NOTHING_SET 5
1336 #define CONFIG_INVALID_PATTERN 6
1337 #define CONFIG_GENERIC_ERROR 7
1338
1339 #define CONFIG_REGEX_NONE ((void *)1)
1340
1341 struct git_config_source {
1342         unsigned int use_stdin:1;
1343         const char *file;
1344         const char *blob;
1345 };
1346
1347 typedef int (*config_fn_t)(const char *, const char *, void *);
1348 extern int git_default_config(const char *, const char *, void *);
1349 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1350 extern int git_config_from_buf(config_fn_t fn, const char *name,
1351                                const char *buf, size_t len, void *data);
1352 extern void git_config_push_parameter(const char *text);
1353 extern int git_config_from_parameters(config_fn_t fn, void *data);
1354 extern void git_config(config_fn_t fn, void *);
1355 extern int git_config_with_options(config_fn_t fn, void *,
1356                                    struct git_config_source *config_source,
1357                                    int respect_includes);
1358 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1359 extern int git_parse_ulong(const char *, unsigned long *);
1360 extern int git_config_int(const char *, const char *);
1361 extern int64_t git_config_int64(const char *, const char *);
1362 extern unsigned long git_config_ulong(const char *, const char *);
1363 extern int git_config_bool_or_int(const char *, const char *, int *);
1364 extern int git_config_bool(const char *, const char *);
1365 extern int git_config_maybe_bool(const char *, const char *);
1366 extern int git_config_string(const char **, const char *, const char *);
1367 extern int git_config_pathname(const char **, const char *, const char *);
1368 extern int git_config_set_in_file(const char *, const char *, const char *);
1369 extern int git_config_set(const char *, const char *);
1370 extern int git_config_parse_key(const char *, char **, int *);
1371 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1372 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1373 extern int git_config_rename_section(const char *, const char *);
1374 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1375 extern const char *git_etc_gitconfig(void);
1376 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1377 extern int git_env_bool(const char *, int);
1378 extern unsigned long git_env_ulong(const char *, unsigned long);
1379 extern int git_config_system(void);
1380 extern int config_error_nonbool(const char *);
1381 #if defined(__GNUC__)
1382 #define config_error_nonbool(s) (config_error_nonbool(s), const_error())
1383 #endif
1384 extern const char *get_log_output_encoding(void);
1385 extern const char *get_commit_output_encoding(void);
1386
1387 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1388
1389 struct config_include_data {
1390         int depth;
1391         config_fn_t fn;
1392         void *data;
1393 };
1394 #define CONFIG_INCLUDE_INIT { 0 }
1395 extern int git_config_include(const char *name, const char *value, void *data);
1396
1397 /*
1398  * Match and parse a config key of the form:
1399  *
1400  *   section.(subsection.)?key
1401  *
1402  * (i.e., what gets handed to a config_fn_t). The caller provides the section;
1403  * we return -1 if it does not match, 0 otherwise. The subsection and key
1404  * out-parameters are filled by the function (and subsection is NULL if it is
1405  * missing).
1406  */
1407 extern int parse_config_key(const char *var,
1408                             const char *section,
1409                             const char **subsection, int *subsection_len,
1410                             const char **key);
1411
1412 struct config_set_element {
1413         struct hashmap_entry ent;
1414         char *key;
1415         struct string_list value_list;
1416 };
1417
1418 struct configset_list_item {
1419         struct config_set_element *e;
1420         int value_index;
1421 };
1422
1423 /*
1424  * the contents of the list are ordered according to their
1425  * position in the config files and order of parsing the files.
1426  * (i.e. key-value pair at the last position of .git/config will
1427  * be at the last item of the list)
1428  */
1429 struct configset_list {
1430         struct configset_list_item *items;
1431         unsigned int nr, alloc;
1432 };
1433
1434 struct config_set {
1435         struct hashmap config_hash;
1436         int hash_initialized;
1437         struct configset_list list;
1438 };
1439
1440 extern void git_configset_init(struct config_set *cs);
1441 extern int git_configset_add_file(struct config_set *cs, const char *filename);
1442 extern int git_configset_get_value(struct config_set *cs, const char *key, const char **value);
1443 extern const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key);
1444 extern void git_configset_clear(struct config_set *cs);
1445 extern int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest);
1446 extern int git_configset_get_string(struct config_set *cs, const char *key, char **dest);
1447 extern int git_configset_get_int(struct config_set *cs, const char *key, int *dest);
1448 extern int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest);
1449 extern int git_configset_get_bool(struct config_set *cs, const char *key, int *dest);
1450 extern int git_configset_get_bool_or_int(struct config_set *cs, const char *key, int *is_bool, int *dest);
1451 extern int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest);
1452 extern int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest);
1453
1454 extern int git_config_get_value(const char *key, const char **value);
1455 extern const struct string_list *git_config_get_value_multi(const char *key);
1456 extern void git_config_clear(void);
1457 extern void git_config_iter(config_fn_t fn, void *data);
1458 extern int git_config_get_string_const(const char *key, const char **dest);
1459 extern int git_config_get_string(const char *key, char **dest);
1460 extern int git_config_get_int(const char *key, int *dest);
1461 extern int git_config_get_ulong(const char *key, unsigned long *dest);
1462 extern int git_config_get_bool(const char *key, int *dest);
1463 extern int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest);
1464 extern int git_config_get_maybe_bool(const char *key, int *dest);
1465 extern int git_config_get_pathname(const char *key, const char **dest);
1466
1467 struct key_value_info {
1468         const char *filename;
1469         int linenr;
1470 };
1471
1472 extern NORETURN void git_die_config(const char *key, const char *err, ...) __attribute__((format(printf, 2, 3)));
1473 extern NORETURN void git_die_config_linenr(const char *key, const char *filename, int linenr);
1474
1475 extern int committer_ident_sufficiently_given(void);
1476 extern int author_ident_sufficiently_given(void);
1477
1478 extern const char *git_commit_encoding;
1479 extern const char *git_log_output_encoding;
1480 extern const char *git_mailmap_file;
1481 extern const char *git_mailmap_blob;
1482
1483 /* IO helper functions */
1484 extern void maybe_flush_or_die(FILE *, const char *);
1485 __attribute__((format (printf, 2, 3)))
1486 extern void fprintf_or_die(FILE *, const char *fmt, ...);
1487 extern int copy_fd(int ifd, int ofd);
1488 extern int copy_file(const char *dst, const char *src, int mode);
1489 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1490 extern void write_or_die(int fd, const void *buf, size_t count);
1491 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1492 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1493 extern void fsync_or_die(int fd, const char *);
1494
1495 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1496 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1497 extern ssize_t pread_in_full(int fd, void *buf, size_t count, off_t offset);
1498
1499 static inline ssize_t write_str_in_full(int fd, const char *str)
1500 {
1501         return write_in_full(fd, str, strlen(str));
1502 }
1503
1504 /* pager.c */
1505 extern void setup_pager(void);
1506 extern const char *pager_program;
1507 extern int pager_in_use(void);
1508 extern int pager_use_color;
1509 extern int term_columns(void);
1510 extern int decimal_width(uintmax_t);
1511 extern int check_pager_config(const char *cmd);
1512
1513 extern const char *editor_program;
1514 extern const char *askpass_program;
1515 extern const char *excludes_file;
1516
1517 /* base85 */
1518 int decode_85(char *dst, const char *line, int linelen);
1519 void encode_85(char *buf, const unsigned char *data, int bytes);
1520
1521 /* alloc.c */
1522 extern void *alloc_blob_node(void);
1523 extern void *alloc_tree_node(void);
1524 extern void *alloc_commit_node(void);
1525 extern void *alloc_tag_node(void);
1526 extern void *alloc_object_node(void);
1527 extern void alloc_report(void);
1528 extern unsigned int alloc_commit_index(void);
1529
1530 /* pkt-line.c */
1531 void packet_trace_identity(const char *prog);
1532
1533 /* add */
1534 /*
1535  * return 0 if success, 1 - if addition of a file failed and
1536  * ADD_FILES_IGNORE_ERRORS was specified in flags
1537  */
1538 int add_files_to_cache(const char *prefix, const struct pathspec *pathspec, int flags);
1539
1540 /* diff.c */
1541 extern int diff_auto_refresh_index;
1542
1543 /* match-trees.c */
1544 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1545 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1546
1547 /*
1548  * whitespace rules.
1549  * used by both diff and apply
1550  * last two digits are tab width
1551  */
1552 #define WS_BLANK_AT_EOL         0100
1553 #define WS_SPACE_BEFORE_TAB     0200
1554 #define WS_INDENT_WITH_NON_TAB  0400
1555 #define WS_CR_AT_EOL           01000
1556 #define WS_BLANK_AT_EOF        02000
1557 #define WS_TAB_IN_INDENT       04000
1558 #define WS_TRAILING_SPACE      (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1559 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1560 #define WS_TAB_WIDTH_MASK        077
1561 extern unsigned whitespace_rule_cfg;
1562 extern unsigned whitespace_rule(const char *);
1563 extern unsigned parse_whitespace_rule(const char *);
1564 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1565 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1566 extern char *whitespace_error_string(unsigned ws);
1567 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1568 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1569 #define ws_tab_width(rule)     ((rule) & WS_TAB_WIDTH_MASK)
1570
1571 /* ls-files */
1572 int report_path_error(const char *ps_matched, const struct pathspec *pathspec, const char *prefix);
1573 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1574
1575 char *alias_lookup(const char *alias);
1576 int split_cmdline(char *cmdline, const char ***argv);
1577 /* Takes a negative value returned by split_cmdline */
1578 const char *split_cmdline_strerror(int cmdline_errno);
1579
1580 /* git.c */
1581 struct startup_info {
1582         int have_repository;
1583         const char *prefix;
1584 };
1585 extern struct startup_info *startup_info;
1586
1587 /* merge.c */
1588 struct commit_list;
1589 int try_merge_command(const char *strategy, size_t xopts_nr,
1590                 const char **xopts, struct commit_list *common,
1591                 const char *head_arg, struct commit_list *remotes);
1592 int checkout_fast_forward(const unsigned char *from,
1593                           const unsigned char *to,
1594                           int overwrite_ignore);
1595
1596
1597 int sane_execvp(const char *file, char *const argv[]);
1598
1599 /*
1600  * A struct to encapsulate the concept of whether a file has changed
1601  * since we last checked it. This uses criteria similar to those used
1602  * for the index.
1603  */
1604 struct stat_validity {
1605         struct stat_data *sd;
1606 };
1607
1608 void stat_validity_clear(struct stat_validity *sv);
1609
1610 /*
1611  * Returns 1 if the path is a regular file (or a symlink to a regular
1612  * file) and matches the saved stat_validity, 0 otherwise.  A missing
1613  * or inaccessible file is considered a match if the struct was just
1614  * initialized, or if the previous update found an inaccessible file.
1615  */
1616 int stat_validity_check(struct stat_validity *sv, const char *path);
1617
1618 /*
1619  * Update the stat_validity from a file opened at descriptor fd. If
1620  * the file is missing, inaccessible, or not a regular file, then
1621  * future calls to stat_validity_check will match iff one of those
1622  * conditions continues to be true.
1623  */
1624 void stat_validity_update(struct stat_validity *sv, int fd);
1625
1626 int versioncmp(const char *s1, const char *s2);
1627
1628 #endif /* CACHE_H */