cache.h

   1 #ifndef CACHE_H
   2 #define CACHE_H
   3
   4 #include "git-compat-util.h"
   5 #include "strbuf.h"
   6 #include "hash.h"
   7 #include "advice.h"
   8 #include "gettext.h"
   9 #include "convert.h"
  10
  11 #include SHA1_HEADER
  12 #ifndef git_SHA_CTX
  13 #define git_SHA_CTX     SHA_CTX
  14 #define git_SHA1_Init   SHA1_Init
  15 #define git_SHA1_Update SHA1_Update
  16 #define git_SHA1_Final  SHA1_Final
  17 #endif
  18
  19 #include <zlib.h>
  20 typedef struct git_zstream {
  21         z_stream z;
  22         unsigned long avail_in;
  23         unsigned long avail_out;
  24         unsigned long total_in;
  25         unsigned long total_out;
  26         unsigned char *next_in;
  27         unsigned char *next_out;
  28 } git_zstream;
  29
  30 void git_inflate_init(git_zstream *);
  31 void git_inflate_init_gzip_only(git_zstream *);
  32 void git_inflate_end(git_zstream *);
  33 int git_inflate(git_zstream *, int flush);
  34
  35 void git_deflate_init(git_zstream *, int level);
  36 void git_deflate_init_gzip(git_zstream *, int level);
  37 void git_deflate_end(git_zstream *);
  38 int git_deflate_abort(git_zstream *);
  39 int git_deflate_end_gently(git_zstream *);
  40 int git_deflate(git_zstream *, int flush);
  41 unsigned long git_deflate_bound(git_zstream *, unsigned long);
  42
  43 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
  44 #define DTYPE(de)       ((de)->d_type)
  45 #else
  46 #undef DT_UNKNOWN
  47 #undef DT_DIR
  48 #undef DT_REG
  49 #undef DT_LNK
  50 #define DT_UNKNOWN      0
  51 #define DT_DIR          1
  52 #define DT_REG          2
  53 #define DT_LNK          3
  54 #define DTYPE(de)       DT_UNKNOWN
  55 #endif
  56
  57 /* unknown mode (impossible combination S_IFIFO|S_IFCHR) */
  58 #define S_IFINVALID     0030000
  59
  60 /*
  61  * A "directory link" is a link to another git directory.
  62  *
  63  * The value 0160000 is not normally a valid mode, and
  64  * also just happens to be S_IFDIR + S_IFLNK
  65  *
  66  * NOTE! We *really* shouldn't depend on the S_IFxxx macros
  67  * always having the same values everywhere. We should use
  68  * our internal git values for these things, and then we can
  69  * translate that to the OS-specific value. It just so
  70  * happens that everybody shares the same bit representation
  71  * in the UNIX world (and apparently wider too..)
  72  */
  73 #define S_IFGITLINK     0160000
  74 #define S_ISGITLINK(m)  (((m) & S_IFMT) == S_IFGITLINK)
  75
  76 /*
  77  * Intensive research over the course of many years has shown that
  78  * port 9418 is totally unused by anything else. Or
  79  *
  80  *      Your search - "port 9418" - did not match any documents.
  81  *
  82  * as www.google.com puts it.
  83  *
  84  * This port has been properly assigned for git use by IANA:
  85  * git (Assigned-9418) [I06-050728-0001].
  86  *
  87  *      git  9418/tcp   git pack transfer service
  88  *      git  9418/udp   git pack transfer service
  89  *
  90  * with Linus Torvalds <torvalds@osdl.org> as the point of
  91  * contact. September 2005.
  92  *
  93  * See http://www.iana.org/assignments/port-numbers
  94  */
  95 #define DEFAULT_GIT_PORT 9418
  96
  97 /*
  98  * Basic data structures for the directory cache
  99  */
 100
 101 #define CACHE_SIGNATURE 0x44495243      /* "DIRC" */
 102 struct cache_header {
 103         unsigned int hdr_signature;
 104         unsigned int hdr_version;
 105         unsigned int hdr_entries;
 106 };
 107
 108 #define INDEX_FORMAT_LB 2
 109 #define INDEX_FORMAT_UB 4
 110
 111 /*
 112  * The "cache_time" is just the low 32 bits of the
 113  * time. It doesn't matter if it overflows - we only
 114  * check it for equality in the 32 bits we save.
 115  */
 116 struct cache_time {
 117         unsigned int sec;
 118         unsigned int nsec;
 119 };
 120
 121 struct cache_entry {
 122         struct cache_time ce_ctime;
 123         struct cache_time ce_mtime;
 124         unsigned int ce_dev;
 125         unsigned int ce_ino;
 126         unsigned int ce_mode;
 127         unsigned int ce_uid;
 128         unsigned int ce_gid;
 129         unsigned int ce_size;
 130         unsigned int ce_flags;
 131         unsigned int ce_namelen;
 132         unsigned char sha1[20];
 133         struct cache_entry *next;
 134         char name[FLEX_ARRAY]; /* more */
 135 };
 136
 137 #define CE_STAGEMASK (0x3000)
 138 #define CE_EXTENDED  (0x4000)
 139 #define CE_VALID     (0x8000)
 140 #define CE_STAGESHIFT 12
 141
 142 /*
 143  * Range 0xFFFF0000 in ce_flags is divided into
 144  * two parts: in-memory flags and on-disk ones.
 145  * Flags in CE_EXTENDED_FLAGS will get saved on-disk
 146  * if you want to save a new flag, add it in
 147  * CE_EXTENDED_FLAGS
 148  *
 149  * In-memory only flags
 150  */
 151 #define CE_UPDATE            (1 << 16)
 152 #define CE_REMOVE            (1 << 17)
 153 #define CE_UPTODATE          (1 << 18)
 154 #define CE_ADDED             (1 << 19)
 155
 156 #define CE_HASHED            (1 << 20)
 157 #define CE_UNHASHED          (1 << 21)
 158 #define CE_WT_REMOVE         (1 << 22) /* remove in work directory */
 159 #define CE_CONFLICTED        (1 << 23)
 160
 161 #define CE_UNPACKED          (1 << 24)
 162 #define CE_NEW_SKIP_WORKTREE (1 << 25)
 163
 164 /*
 165  * Extended on-disk flags
 166  */
 167 #define CE_INTENT_TO_ADD     (1 << 29)
 168 #define CE_SKIP_WORKTREE     (1 << 30)
 169 /* CE_EXTENDED2 is for future extension */
 170 #define CE_EXTENDED2         (1 << 31)
 171
 172 #define CE_EXTENDED_FLAGS (CE_INTENT_TO_ADD | CE_SKIP_WORKTREE)
 173
 174 /*
 175  * Safeguard to avoid saving wrong flags:
 176  *  - CE_EXTENDED2 won't get saved until its semantic is known
 177  *  - Bits in 0x0000FFFF have been saved in ce_flags already
 178  *  - Bits in 0x003F0000 are currently in-memory flags
 179  */
 180 #if CE_EXTENDED_FLAGS & 0x803FFFFF
 181 #error "CE_EXTENDED_FLAGS out of range"
 182 #endif
 183
 184 /*
 185  * Copy the sha1 and stat state of a cache entry from one to
 186  * another. But we never change the name, or the hash state!
 187  */
 188 #define CE_STATE_MASK (CE_HASHED | CE_UNHASHED)
 189 static inline void copy_cache_entry(struct cache_entry *dst, struct cache_entry *src)
 190 {
 191         unsigned int state = dst->ce_flags & CE_STATE_MASK;
 192
 193         /* Don't copy hash chain and name */
 194         memcpy(dst, src, offsetof(struct cache_entry, next));
 195
 196         /* Restore the hash state */
 197         dst->ce_flags = (dst->ce_flags & ~CE_STATE_MASK) | state;
 198 }
 199
 200 static inline unsigned create_ce_flags(unsigned stage)
 201 {
 202         return (stage << CE_STAGESHIFT);
 203 }
 204
 205 #define ce_namelen(ce) ((ce)->ce_namelen)
 206 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
 207 #define ce_stage(ce) ((CE_STAGEMASK & (ce)->ce_flags) >> CE_STAGESHIFT)
 208 #define ce_uptodate(ce) ((ce)->ce_flags & CE_UPTODATE)
 209 #define ce_skip_worktree(ce) ((ce)->ce_flags & CE_SKIP_WORKTREE)
 210 #define ce_mark_uptodate(ce) ((ce)->ce_flags |= CE_UPTODATE)
 211
 212 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
 213 static inline unsigned int create_ce_mode(unsigned int mode)
 214 {
 215         if (S_ISLNK(mode))
 216                 return S_IFLNK;
 217         if (S_ISDIR(mode) || S_ISGITLINK(mode))
 218                 return S_IFGITLINK;
 219         return S_IFREG | ce_permissions(mode);
 220 }
 221 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
 222 {
 223         extern int trust_executable_bit, has_symlinks;
 224         if (!has_symlinks && S_ISREG(mode) &&
 225             ce && S_ISLNK(ce->ce_mode))
 226                 return ce->ce_mode;
 227         if (!trust_executable_bit && S_ISREG(mode)) {
 228                 if (ce && S_ISREG(ce->ce_mode))
 229                         return ce->ce_mode;
 230                 return create_ce_mode(0666);
 231         }
 232         return create_ce_mode(mode);
 233 }
 234 static inline int ce_to_dtype(const struct cache_entry *ce)
 235 {
 236         unsigned ce_mode = ntohl(ce->ce_mode);
 237         if (S_ISREG(ce_mode))
 238                 return DT_REG;
 239         else if (S_ISDIR(ce_mode) || S_ISGITLINK(ce_mode))
 240                 return DT_DIR;
 241         else if (S_ISLNK(ce_mode))
 242                 return DT_LNK;
 243         else
 244                 return DT_UNKNOWN;
 245 }
 246 static inline unsigned int canon_mode(unsigned int mode)
 247 {
 248         if (S_ISREG(mode))
 249                 return S_IFREG | ce_permissions(mode);
 250         if (S_ISLNK(mode))
 251                 return S_IFLNK;
 252         if (S_ISDIR(mode))
 253                 return S_IFDIR;
 254         return S_IFGITLINK;
 255 }
 256
 257 #define cache_entry_size(len) (offsetof(struct cache_entry,name) + (len) + 1)
 258
 259 struct index_state {
 260         struct cache_entry **cache;
 261         unsigned int version;
 262         unsigned int cache_nr, cache_alloc, cache_changed;
 263         struct string_list *resolve_undo;
 264         struct cache_tree *cache_tree;
 265         struct cache_time timestamp;
 266         unsigned name_hash_initialized : 1,
 267                  initialized : 1;
 268         struct hash_table name_hash;
 269         struct hash_table dir_hash;
 270 };
 271
 272 extern struct index_state the_index;
 273
 274 /* Name hashing */
 275 extern void add_name_hash(struct index_state *istate, struct cache_entry *ce);
 276 extern void remove_name_hash(struct index_state *istate, struct cache_entry *ce);
 277 extern void free_name_hash(struct index_state *istate);
 278
 279
 280 #ifndef NO_THE_INDEX_COMPATIBILITY_MACROS
 281 #define active_cache (the_index.cache)
 282 #define active_nr (the_index.cache_nr)
 283 #define active_alloc (the_index.cache_alloc)
 284 #define active_cache_changed (the_index.cache_changed)
 285 #define active_cache_tree (the_index.cache_tree)
 286
 287 #define read_cache() read_index(&the_index)
 288 #define read_cache_from(path) read_index_from(&the_index, (path))
 289 #define read_cache_preload(pathspec) read_index_preload(&the_index, (pathspec))
 290 #define is_cache_unborn() is_index_unborn(&the_index)
 291 #define read_cache_unmerged() read_index_unmerged(&the_index)
 292 #define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
 293 #define discard_cache() discard_index(&the_index)
 294 #define unmerged_cache() unmerged_index(&the_index)
 295 #define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
 296 #define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
 297 #define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
 298 #define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
 299 #define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
 300 #define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
 301 #define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
 302 #define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL, NULL)
 303 #define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
 304 #define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
 305 #define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
 306 #define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
 307 #define resolve_undo_clear() resolve_undo_clear_index(&the_index)
 308 #define unmerge_cache_entry_at(at) unmerge_index_entry_at(&the_index, at)
 309 #define unmerge_cache(pathspec) unmerge_index(&the_index, pathspec)
 310 #endif
 311
 312 enum object_type {
 313         OBJ_BAD = -1,
 314         OBJ_NONE = 0,
 315         OBJ_COMMIT = 1,
 316         OBJ_TREE = 2,
 317         OBJ_BLOB = 3,
 318         OBJ_TAG = 4,
 319         /* 5 for future expansion */
 320         OBJ_OFS_DELTA = 6,
 321         OBJ_REF_DELTA = 7,
 322         OBJ_ANY,
 323         OBJ_MAX
 324 };
 325
 326 static inline enum object_type object_type(unsigned int mode)
 327 {
 328         return S_ISDIR(mode) ? OBJ_TREE :
 329                 S_ISGITLINK(mode) ? OBJ_COMMIT :
 330                 OBJ_BLOB;
 331 }
 332
 333 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
 334 #define GIT_NAMESPACE_ENVIRONMENT "GIT_NAMESPACE"
 335 #define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
 336 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
 337 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
 338 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
 339 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
 340 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
 341 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
 342 #define CONFIG_DATA_ENVIRONMENT "GIT_CONFIG_PARAMETERS"
 343 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
 344 #define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
 345 #define NO_REPLACE_OBJECTS_ENVIRONMENT "GIT_NO_REPLACE_OBJECTS"
 346 #define GITATTRIBUTES_FILE ".gitattributes"
 347 #define INFOATTRIBUTES_FILE "info/attributes"
 348 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
 349 #define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
 350 #define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
 351 #define GIT_NOTES_DISPLAY_REF_ENVIRONMENT "GIT_NOTES_DISPLAY_REF"
 352 #define GIT_NOTES_REWRITE_REF_ENVIRONMENT "GIT_NOTES_REWRITE_REF"
 353 #define GIT_NOTES_REWRITE_MODE_ENVIRONMENT "GIT_NOTES_REWRITE_MODE"
 354
 355 /*
 356  * Repository-local GIT_* environment variables
 357  * The array is NULL-terminated to simplify its usage in contexts such
 358  * environment creation or simple walk of the list.
 359  * The number of non-NULL entries is available as a macro.
 360  */
 361 #define LOCAL_REPO_ENV_SIZE 9
 362 extern const char *const local_repo_env[LOCAL_REPO_ENV_SIZE + 1];
 363
 364 extern int is_bare_repository_cfg;
 365 extern int is_bare_repository(void);
 366 extern int is_inside_git_dir(void);
 367 extern char *git_work_tree_cfg;
 368 extern int is_inside_work_tree(void);
 369 extern int have_git_dir(void);
 370 extern const char *get_git_dir(void);
 371 extern int is_git_directory(const char *path);
 372 extern char *get_object_directory(void);
 373 extern char *get_index_file(void);
 374 extern char *get_graft_file(void);
 375 extern int set_git_dir(const char *path);
 376 extern const char *get_git_namespace(void);
 377 extern const char *strip_namespace(const char *namespaced_ref);
 378 extern const char *get_git_work_tree(void);
 379 extern const char *read_gitfile(const char *path);
 380 extern const char *resolve_gitdir(const char *suspect);
 381 extern void set_git_work_tree(const char *tree);
 382
 383 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
 384
 385 extern const char **get_pathspec(const char *prefix, const char **pathspec);
 386 extern void setup_work_tree(void);
 387 extern const char *setup_git_directory_gently(int *);
 388 extern const char *setup_git_directory(void);
 389 extern char *prefix_path(const char *prefix, int len, const char *path);
 390 extern const char *prefix_filename(const char *prefix, int len, const char *path);
 391 extern int check_filename(const char *prefix, const char *name);
 392 extern void verify_filename(const char *prefix,
 393                             const char *name,
 394                             int diagnose_misspelt_rev);
 395 extern void verify_non_filename(const char *prefix, const char *name);
 396 extern int path_inside_repo(const char *prefix, const char *path);
 397
 398 #define INIT_DB_QUIET 0x0001
 399
 400 extern int set_git_dir_init(const char *git_dir, const char *real_git_dir, int);
 401 extern int init_db(const char *template_dir, unsigned int flags);
 402
 403 #define alloc_nr(x) (((x)+16)*3/2)
 404
 405 /*
 406  * Realloc the buffer pointed at by variable 'x' so that it can hold
 407  * at least 'nr' entries; the number of entries currently allocated
 408  * is 'alloc', using the standard growing factor alloc_nr() macro.
 409  *
 410  * DO NOT USE any expression with side-effect for 'x', 'nr', or 'alloc'.
 411  */
 412 #define ALLOC_GROW(x, nr, alloc) \
 413         do { \
 414                 if ((nr) > alloc) { \
 415                         if (alloc_nr(alloc) < (nr)) \
 416                                 alloc = (nr); \
 417                         else \
 418                                 alloc = alloc_nr(alloc); \
 419                         x = xrealloc((x), alloc * sizeof(*(x))); \
 420                 } \
 421         } while (0)
 422
 423 /* Initialize and use the cache information */
 424 extern int read_index(struct index_state *);
 425 extern int read_index_preload(struct index_state *, const char **pathspec);
 426 extern int read_index_from(struct index_state *, const char *path);
 427 extern int is_index_unborn(struct index_state *);
 428 extern int read_index_unmerged(struct index_state *);
 429 extern int write_index(struct index_state *, int newfd);
 430 extern int discard_index(struct index_state *);
 431 extern int unmerged_index(const struct index_state *);
 432 extern int verify_path(const char *path);
 433 extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
 434 extern int index_name_pos(const struct index_state *, const char *name, int namelen);
 435 #define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
 436 #define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
 437 #define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
 438 #define ADD_CACHE_JUST_APPEND 8         /* Append only; tree.c::read_tree() */
 439 #define ADD_CACHE_NEW_ONLY 16           /* Do not replace existing ones */
 440 extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
 441 extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
 442 extern int remove_index_entry_at(struct index_state *, int pos);
 443 extern void remove_marked_cache_entries(struct index_state *istate);
 444 extern int remove_file_from_index(struct index_state *, const char *path);
 445 #define ADD_CACHE_VERBOSE 1
 446 #define ADD_CACHE_PRETEND 2
 447 #define ADD_CACHE_IGNORE_ERRORS 4
 448 #define ADD_CACHE_IGNORE_REMOVAL 8
 449 #define ADD_CACHE_INTENT 16
 450 extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
 451 extern int add_file_to_index(struct index_state *, const char *path, int flags);
 452 extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
 453 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
 454 extern int index_name_is_other(const struct index_state *, const char *, int);
 455
 456 /* do stat comparison even if CE_VALID is true */
 457 #define CE_MATCH_IGNORE_VALID           01
 458 /* do not check the contents but report dirty on racily-clean entries */
 459 #define CE_MATCH_RACY_IS_DIRTY          02
 460 /* do stat comparison even if CE_SKIP_WORKTREE is true */
 461 #define CE_MATCH_IGNORE_SKIP_WORKTREE   04
 462 extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
 463 extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
 464
 465 struct pathspec {
 466         const char **raw; /* get_pathspec() result, not freed by free_pathspec() */
 467         int nr;
 468         unsigned int has_wildcard:1;
 469         unsigned int recursive:1;
 470         int max_depth;
 471         struct pathspec_item {
 472                 const char *match;
 473                 int len;
 474                 unsigned int use_wildcard:1;
 475         } *items;
 476 };
 477
 478 extern int init_pathspec(struct pathspec *, const char **);
 479 extern void free_pathspec(struct pathspec *);
 480 extern int ce_path_match(const struct cache_entry *ce, const struct pathspec *pathspec);
 481
 482 #define HASH_WRITE_OBJECT 1
 483 #define HASH_FORMAT_CHECK 2
 484 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, enum object_type type, const char *path, unsigned flags);
 485 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, unsigned flags);
 486 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
 487
 488 #define REFRESH_REALLY          0x0001  /* ignore_valid */
 489 #define REFRESH_UNMERGED        0x0002  /* allow unmerged */
 490 #define REFRESH_QUIET           0x0004  /* be quiet about it */
 491 #define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
 492 #define REFRESH_IGNORE_SUBMODULES       0x0010  /* ignore submodules */
 493 #define REFRESH_IN_PORCELAIN    0x0020  /* user friendly output, not "needs update" */
 494 extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen, const char *header_msg);
 495
 496 struct lock_file {
 497         struct lock_file *next;
 498         int fd;
 499         pid_t owner;
 500         char on_list;
 501         char filename[PATH_MAX];
 502 };
 503 #define LOCK_DIE_ON_ERROR 1
 504 #define LOCK_NODEREF 2
 505 extern int unable_to_lock_error(const char *path, int err);
 506 extern NORETURN void unable_to_lock_index_die(const char *path, int err);
 507 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
 508 extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
 509 extern int commit_lock_file(struct lock_file *);
 510 extern void update_index_if_able(struct index_state *, struct lock_file *);
 511
 512 extern int hold_locked_index(struct lock_file *, int);
 513 extern int commit_locked_index(struct lock_file *);
 514 extern void set_alternate_index_output(const char *);
 515 extern int close_lock_file(struct lock_file *);
 516 extern void rollback_lock_file(struct lock_file *);
 517 extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
 518
 519 /* Environment bits from configuration mechanism */
 520 extern int trust_executable_bit;
 521 extern int trust_ctime;
 522 extern int quote_path_fully;
 523 extern int has_symlinks;
 524 extern int minimum_abbrev, default_abbrev;
 525 extern int ignore_case;
 526 extern int assume_unchanged;
 527 extern int prefer_symlink_refs;
 528 extern int log_all_ref_updates;
 529 extern int warn_ambiguous_refs;
 530 extern int shared_repository;
 531 extern const char *apply_default_whitespace;
 532 extern const char *apply_default_ignorewhitespace;
 533 extern const char *git_attributes_file;
 534 extern int zlib_compression_level;
 535 extern int core_compression_level;
 536 extern int core_compression_seen;
 537 extern size_t packed_git_window_size;
 538 extern size_t packed_git_limit;
 539 extern size_t delta_base_cache_limit;
 540 extern unsigned long big_file_threshold;
 541 extern unsigned long pack_size_limit_cfg;
 542 extern int read_replace_refs;
 543 extern int fsync_object_files;
 544 extern int core_preload_index;
 545 extern int core_apply_sparse_checkout;
 546 extern int precomposed_unicode;
 547
 548 enum branch_track {
 549         BRANCH_TRACK_UNSPECIFIED = -1,
 550         BRANCH_TRACK_NEVER = 0,
 551         BRANCH_TRACK_REMOTE,
 552         BRANCH_TRACK_ALWAYS,
 553         BRANCH_TRACK_EXPLICIT,
 554         BRANCH_TRACK_OVERRIDE
 555 };
 556
 557 enum rebase_setup_type {
 558         AUTOREBASE_NEVER = 0,
 559         AUTOREBASE_LOCAL,
 560         AUTOREBASE_REMOTE,
 561         AUTOREBASE_ALWAYS
 562 };
 563
 564 enum push_default_type {
 565         PUSH_DEFAULT_NOTHING = 0,
 566         PUSH_DEFAULT_MATCHING,
 567         PUSH_DEFAULT_SIMPLE,
 568         PUSH_DEFAULT_UPSTREAM,
 569         PUSH_DEFAULT_CURRENT,
 570         PUSH_DEFAULT_UNSPECIFIED
 571 };
 572
 573 extern enum branch_track git_branch_track;
 574 extern enum rebase_setup_type autorebase;
 575 extern enum push_default_type push_default;
 576
 577 enum object_creation_mode {
 578         OBJECT_CREATION_USES_HARDLINKS = 0,
 579         OBJECT_CREATION_USES_RENAMES = 1
 580 };
 581
 582 extern enum object_creation_mode object_creation_mode;
 583
 584 extern char *notes_ref_name;
 585
 586 extern int grafts_replace_parents;
 587
 588 #define GIT_REPO_VERSION 0
 589 extern int repository_format_version;
 590 extern int check_repository_format(void);
 591
 592 #define MTIME_CHANGED   0x0001
 593 #define CTIME_CHANGED   0x0002
 594 #define OWNER_CHANGED   0x0004
 595 #define MODE_CHANGED    0x0008
 596 #define INODE_CHANGED   0x0010
 597 #define DATA_CHANGED    0x0020
 598 #define TYPE_CHANGED    0x0040
 599
 600 extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
 601         __attribute__((format (printf, 3, 4)));
 602 extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
 603         __attribute__((format (printf, 3, 4)));
 604 extern char *git_pathdup(const char *fmt, ...)
 605         __attribute__((format (printf, 1, 2)));
 606 extern char *mkpathdup(const char *fmt, ...)
 607         __attribute__((format (printf, 1, 2)));
 608
 609 /* Return a statically allocated filename matching the sha1 signature */
 610 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 611 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 612 extern char *git_path_submodule(const char *path, const char *fmt, ...)
 613         __attribute__((format (printf, 2, 3)));
 614
 615 extern char *sha1_file_name(const unsigned char *sha1);
 616 extern char *sha1_pack_name(const unsigned char *sha1);
 617 extern char *sha1_pack_index_name(const unsigned char *sha1);
 618 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
 619 extern const unsigned char null_sha1[20];
 620
 621 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
 622 {
 623         int i;
 624
 625         for (i = 0; i < 20; i++, sha1++, sha2++) {
 626                 if (*sha1 != *sha2)
 627                         return *sha1 - *sha2;
 628         }
 629
 630         return 0;
 631 }
 632
 633 static inline int is_null_sha1(const unsigned char *sha1)
 634 {
 635         return !hashcmp(sha1, null_sha1);
 636 }
 637
 638 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
 639 {
 640         memcpy(sha_dst, sha_src, 20);
 641 }
 642 static inline void hashclr(unsigned char *hash)
 643 {
 644         memset(hash, 0, 20);
 645 }
 646
 647 #define EMPTY_TREE_SHA1_HEX \
 648         "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
 649 #define EMPTY_TREE_SHA1_BIN_LITERAL \
 650          "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
 651          "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
 652 #define EMPTY_TREE_SHA1_BIN \
 653          ((const unsigned char *) EMPTY_TREE_SHA1_BIN_LITERAL)
 654
 655 #define EMPTY_BLOB_SHA1_HEX \
 656         "e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"
 657 #define EMPTY_BLOB_SHA1_BIN_LITERAL \
 658         "\xe6\x9d\xe2\x9b\xb2\xd1\xd6\x43\x4b\x8b" \
 659         "\x29\xae\x77\x5a\xd8\xc2\xe4\x8c\x53\x91"
 660 #define EMPTY_BLOB_SHA1_BIN \
 661         ((const unsigned char *) EMPTY_BLOB_SHA1_BIN_LITERAL)
 662
 663 static inline int is_empty_blob_sha1(const unsigned char *sha1)
 664 {
 665         return !hashcmp(sha1, EMPTY_BLOB_SHA1_BIN);
 666 }
 667
 668 int git_mkstemp(char *path, size_t n, const char *template);
 669
 670 int git_mkstemps(char *path, size_t n, const char *template, int suffix_len);
 671
 672 /* set default permissions by passing mode arguments to open(2) */
 673 int git_mkstemps_mode(char *pattern, int suffix_len, int mode);
 674 int git_mkstemp_mode(char *pattern, int mode);
 675
 676 /*
 677  * NOTE NOTE NOTE!!
 678  *
 679  * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
 680  * not be changed. Old repositories have core.sharedrepository written in
 681  * numeric format, and therefore these values are preserved for compatibility
 682  * reasons.
 683  */
 684 enum sharedrepo {
 685         PERM_UMASK          = 0,
 686         OLD_PERM_GROUP      = 1,
 687         OLD_PERM_EVERYBODY  = 2,
 688         PERM_GROUP          = 0660,
 689         PERM_EVERYBODY      = 0664
 690 };
 691 int git_config_perm(const char *var, const char *value);
 692 int set_shared_perm(const char *path, int mode);
 693 #define adjust_shared_perm(path) set_shared_perm((path), 0)
 694 int safe_create_leading_directories(char *path);
 695 int safe_create_leading_directories_const(const char *path);
 696 int mkdir_in_gitdir(const char *path);
 697 extern void home_config_paths(char **global, char **xdg, char *file);
 698 extern char *expand_user_path(const char *path);
 699 const char *enter_repo(const char *path, int strict);
 700 static inline int is_absolute_path(const char *path)
 701 {
 702         return is_dir_sep(path[0]) || has_dos_drive_prefix(path);
 703 }
 704 int is_directory(const char *);
 705 const char *real_path(const char *path);
 706 const char *real_path_if_valid(const char *path);
 707 const char *absolute_path(const char *path);
 708 const char *relative_path(const char *abs, const char *base);
 709 int normalize_path_copy(char *dst, const char *src);
 710 int longest_ancestor_length(const char *path, struct string_list *prefixes);
 711 char *strip_path_suffix(const char *path, const char *suffix);
 712 int daemon_avoid_alias(const char *path);
 713 int offset_1st_component(const char *path);
 714
 715 /* object replacement */
 716 #define READ_SHA1_FILE_REPLACE 1
 717 extern void *read_sha1_file_extended(const unsigned char *sha1, enum object_type *type, unsigned long *size, unsigned flag);
 718 static inline void *read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size)
 719 {
 720         return read_sha1_file_extended(sha1, type, size, READ_SHA1_FILE_REPLACE);
 721 }
 722 extern const unsigned char *do_lookup_replace_object(const unsigned char *sha1);
 723 static inline const unsigned char *lookup_replace_object(const unsigned char *sha1)
 724 {
 725         if (!read_replace_refs)
 726                 return sha1;
 727         return do_lookup_replace_object(sha1);
 728 }
 729
 730 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
 731 extern int sha1_object_info(const unsigned char *, unsigned long *);
 732 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
 733 extern int write_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
 734 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
 735 extern int force_object_loose(const unsigned char *sha1, time_t mtime);
 736 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *size);
 737 extern int unpack_sha1_header(git_zstream *stream, unsigned char *map, unsigned long mapsize, void *buffer, unsigned long bufsiz);
 738 extern int parse_sha1_header(const char *hdr, unsigned long *sizep);
 739
 740 /* global flag to enable extra checks when accessing packed objects */
 741 extern int do_check_packed_object_crc;
 742
 743 /* for development: log offset of pack access */
 744 extern const char *log_pack_access;
 745
 746 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
 747
 748 extern int move_temp_to_file(const char *tmpfile, const char *filename);
 749
 750 extern int has_sha1_pack(const unsigned char *sha1);
 751 extern int has_sha1_file(const unsigned char *sha1);
 752 extern int has_loose_object_nonlocal(const unsigned char *sha1);
 753
 754 extern int has_pack_index(const unsigned char *sha1);
 755
 756 extern void assert_sha1_type(const unsigned char *sha1, enum object_type expect);
 757
 758 extern const signed char hexval_table[256];
 759 static inline unsigned int hexval(unsigned char c)
 760 {
 761         return hexval_table[c];
 762 }
 763
 764 /* Convert to/from hex/sha1 representation */
 765 #define MINIMUM_ABBREV minimum_abbrev
 766 #define DEFAULT_ABBREV default_abbrev
 767
 768 struct object_context {
 769         unsigned char tree[20];
 770         char path[PATH_MAX];
 771         unsigned mode;
 772 };
 773
 774 #define GET_SHA1_QUIETLY        01
 775 #define GET_SHA1_COMMIT         02
 776 #define GET_SHA1_COMMITTISH     04
 777 #define GET_SHA1_TREE          010
 778 #define GET_SHA1_TREEISH       020
 779 #define GET_SHA1_BLOB          040
 780 #define GET_SHA1_ONLY_TO_DIE 04000
 781
 782 extern int get_sha1(const char *str, unsigned char *sha1);
 783 extern int get_sha1_commit(const char *str, unsigned char *sha1);
 784 extern int get_sha1_committish(const char *str, unsigned char *sha1);
 785 extern int get_sha1_tree(const char *str, unsigned char *sha1);
 786 extern int get_sha1_treeish(const char *str, unsigned char *sha1);
 787 extern int get_sha1_blob(const char *str, unsigned char *sha1);
 788 extern void maybe_die_on_misspelt_object_name(const char *name, const char *prefix);
 789 extern int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc);
 790
 791 typedef int each_abbrev_fn(const unsigned char *sha1, void *);
 792 extern int for_each_abbrev(const char *prefix, each_abbrev_fn, void *);
 793
 794 /*
 795  * Try to read a SHA1 in hexadecimal format from the 40 characters
 796  * starting at hex.  Write the 20-byte result to sha1 in binary form.
 797  * Return 0 on success.  Reading stops if a NUL is encountered in the
 798  * input, so it is safe to pass this function an arbitrary
 799  * null-terminated string.
 800  */
 801 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
 802
 803 extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
 804 extern int read_ref_full(const char *refname, unsigned char *sha1,
 805                          int reading, int *flags);
 806 extern int read_ref(const char *refname, unsigned char *sha1);
 807
 808 /*
 809  * Resolve a reference, recursively following symbolic refererences.
 810  *
 811  * Store the referred-to object's name in sha1 and return the name of
 812  * the non-symbolic reference that ultimately pointed at it.  The
 813  * return value, if not NULL, is a pointer into either a static buffer
 814  * or the input ref.
 815  *
 816  * If the reference cannot be resolved to an object, the behavior
 817  * depends on the "reading" argument:
 818  *
 819  * - If reading is set, return NULL.
 820  *
 821  * - If reading is not set, clear sha1 and return the name of the last
 822  *   reference name in the chain, which will either be a non-symbolic
 823  *   reference or an undefined reference.  If this is a prelude to
 824  *   "writing" to the ref, the return value is the name of the ref
 825  *   that will actually be created or changed.
 826  *
 827  * If flag is non-NULL, set the value that it points to the
 828  * combination of REF_ISPACKED (if the reference was found among the
 829  * packed references) and REF_ISSYMREF (if the initial reference was a
 830  * symbolic reference).
 831  *
 832  * If ref is not a properly-formatted, normalized reference, return
 833  * NULL.  If more than MAXDEPTH recursive symbolic lookups are needed,
 834  * give up and return NULL.
 835  *
 836  * errno is sometimes set on errors, but not always.
 837  */
 838 extern const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag);
 839 extern char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag);
 840
 841 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
 842 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
 843 extern int interpret_branch_name(const char *str, struct strbuf *);
 844 extern int get_sha1_mb(const char *str, unsigned char *sha1);
 845
 846 extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
 847 extern const char *ref_rev_parse_rules[];
 848 #define ref_fetch_rules ref_rev_parse_rules
 849
 850 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
 851 extern int validate_headref(const char *ref);
 852
 853 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
 854 extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
 855 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
 856 extern int cache_name_stage_compare(const char *name1, int len1, int stage1, const char *name2, int len2, int stage2);
 857
 858 extern void *read_object_with_reference(const unsigned char *sha1,
 859                                         const char *required_type,
 860                                         unsigned long *size,
 861                                         unsigned char *sha1_ret);
 862
 863 extern struct object *peel_to_type(const char *name, int namelen,
 864                                    struct object *o, enum object_type);
 865
 866 enum date_mode {
 867         DATE_NORMAL = 0,
 868         DATE_RELATIVE,
 869         DATE_SHORT,
 870         DATE_LOCAL,
 871         DATE_ISO8601,
 872         DATE_RFC2822,
 873         DATE_RAW
 874 };
 875
 876 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
 877 void show_date_relative(unsigned long time, int tz, const struct timeval *now,
 878                         struct strbuf *timebuf);
 879 int parse_date(const char *date, char *buf, int bufsize);
 880 int parse_date_basic(const char *date, unsigned long *timestamp, int *offset);
 881 int parse_expiry_date(const char *date, unsigned long *timestamp);
 882 void datestamp(char *buf, int bufsize);
 883 #define approxidate(s) approxidate_careful((s), NULL)
 884 unsigned long approxidate_careful(const char *, int *);
 885 unsigned long approxidate_relative(const char *date, const struct timeval *now);
 886 enum date_mode parse_date_format(const char *format);
 887
 888 #define IDENT_STRICT           1
 889 #define IDENT_NO_DATE          2
 890 #define IDENT_NO_NAME          4
 891 extern const char *git_author_info(int);
 892 extern const char *git_committer_info(int);
 893 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
 894 extern const char *fmt_name(const char *name, const char *email);
 895 extern const char *ident_default_email(void);
 896 extern const char *git_editor(void);
 897 extern const char *git_pager(int stdout_is_tty);
 898 extern int git_ident_config(const char *, const char *, void *);
 899
 900 struct ident_split {
 901         const char *name_begin;
 902         const char *name_end;
 903         const char *mail_begin;
 904         const char *mail_end;
 905         const char *date_begin;
 906         const char *date_end;
 907         const char *tz_begin;
 908         const char *tz_end;
 909 };
 910 /*
 911  * Signals an success with 0, but time part of the result may be NULL
 912  * if the input lacks timestamp and zone
 913  */
 914 extern int split_ident_line(struct ident_split *, const char *, int);
 915
 916 struct checkout {
 917         const char *base_dir;
 918         int base_dir_len;
 919         unsigned force:1,
 920                  quiet:1,
 921                  not_new:1,
 922                  refresh_cache:1;
 923 };
 924
 925 extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
 926
 927 struct cache_def {
 928         char path[PATH_MAX + 1];
 929         int len;
 930         int flags;
 931         int track_flags;
 932         int prefix_len_stat_func;
 933 };
 934
 935 extern int has_symlink_leading_path(const char *name, int len);
 936 extern int threaded_has_symlink_leading_path(struct cache_def *, const char *, int);
 937 extern int check_leading_path(const char *name, int len);
 938 extern int has_dirs_only_path(const char *name, int len, int prefix_len);
 939 extern void schedule_dir_for_removal(const char *name, int len);
 940 extern void remove_scheduled_dirs(void);
 941
 942 extern struct alternate_object_database {
 943         struct alternate_object_database *next;
 944         char *name;
 945         char base[FLEX_ARRAY]; /* more */
 946 } *alt_odb_list;
 947 extern void prepare_alt_odb(void);
 948 extern void read_info_alternates(const char * relative_base, int depth);
 949 extern void add_to_alternates_file(const char *reference);
 950 typedef int alt_odb_fn(struct alternate_object_database *, void *);
 951 extern void foreach_alt_odb(alt_odb_fn, void*);
 952
 953 struct pack_window {
 954         struct pack_window *next;
 955         unsigned char *base;
 956         off_t offset;
 957         size_t len;
 958         unsigned int last_used;
 959         unsigned int inuse_cnt;
 960 };
 961
 962 extern struct packed_git {
 963         struct packed_git *next;
 964         struct pack_window *windows;
 965         off_t pack_size;
 966         const void *index_data;
 967         size_t index_size;
 968         uint32_t num_objects;
 969         uint32_t num_bad_objects;
 970         unsigned char *bad_object_sha1;
 971         int index_version;
 972         time_t mtime;
 973         int pack_fd;
 974         unsigned pack_local:1,
 975                  pack_keep:1,
 976                  do_not_close:1;
 977         unsigned char sha1[20];
 978         /* something like ".git/objects/pack/xxxxx.pack" */
 979         char pack_name[FLEX_ARRAY]; /* more */
 980 } *packed_git;
 981
 982 struct pack_entry {
 983         off_t offset;
 984         unsigned char sha1[20];
 985         struct packed_git *p;
 986 };
 987
 988 struct ref {
 989         struct ref *next;
 990         unsigned char old_sha1[20];
 991         unsigned char new_sha1[20];
 992         char *symref;
 993         unsigned int force:1,
 994                 merge:1,
 995                 nonfastforward:1,
 996                 deletion:1;
 997         enum {
 998                 REF_STATUS_NONE = 0,
 999                 REF_STATUS_OK,
1000                 REF_STATUS_REJECT_NONFASTFORWARD,
1001                 REF_STATUS_REJECT_NODELETE,
1002                 REF_STATUS_UPTODATE,
1003                 REF_STATUS_REMOTE_REJECT,
1004                 REF_STATUS_EXPECTING_REPORT
1005         } status;
1006         char *remote_status;
1007         struct ref *peer_ref; /* when renaming */
1008         char name[FLEX_ARRAY]; /* more */
1009 };
1010
1011 #define REF_NORMAL      (1u << 0)
1012 #define REF_HEADS       (1u << 1)
1013 #define REF_TAGS        (1u << 2)
1014
1015 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
1016
1017 #define CONNECT_VERBOSE       (1u << 0)
1018 extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
1019 extern int finish_connect(struct child_process *conn);
1020 extern int git_connection_is_socket(struct child_process *conn);
1021 struct extra_have_objects {
1022         int nr, alloc;
1023         unsigned char (*array)[20];
1024 };
1025 extern struct ref **get_remote_heads(int in, struct ref **list, unsigned int flags, struct extra_have_objects *);
1026 extern int server_supports(const char *feature);
1027 extern int parse_feature_request(const char *features, const char *feature);
1028 extern const char *server_feature_value(const char *feature, int *len_ret);
1029 extern const char *parse_feature_value(const char *feature_list, const char *feature, int *len_ret);
1030
1031 extern struct packed_git *parse_pack_index(unsigned char *sha1, const char *idx_path);
1032
1033 extern void prepare_packed_git(void);
1034 extern void reprepare_packed_git(void);
1035 extern void install_packed_git(struct packed_git *pack);
1036
1037 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
1038                                          struct packed_git *packs);
1039
1040 extern void pack_report(void);
1041 extern int open_pack_index(struct packed_git *);
1042 extern void close_pack_index(struct packed_git *);
1043 extern unsigned char *use_pack(struct packed_git *, struct pack_window **, off_t, unsigned long *);
1044 extern void close_pack_windows(struct packed_git *);
1045 extern void unuse_pack(struct pack_window **);
1046 extern void free_pack_by_name(const char *);
1047 extern void clear_delta_base_cache(void);
1048 extern struct packed_git *add_packed_git(const char *, int, int);
1049 extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
1050 extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
1051 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
1052 extern int is_pack_valid(struct packed_git *);
1053 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
1054 extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
1055 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
1056 extern int unpack_object_header(struct packed_git *, struct pack_window **, off_t *, unsigned long *);
1057
1058 struct object_info {
1059         /* Request */
1060         unsigned long *sizep;
1061
1062         /* Response */
1063         enum {
1064                 OI_CACHED,
1065                 OI_LOOSE,
1066                 OI_PACKED,
1067                 OI_DBCACHED
1068         } whence;
1069         union {
1070                 /*
1071                  * struct {
1072                  *      ... Nothing to expose in this case
1073                  * } cached;
1074                  * struct {
1075                  *      ... Nothing to expose in this case
1076                  * } loose;
1077                  */
1078                 struct {
1079                         struct packed_git *pack;
1080                         off_t offset;
1081                         unsigned int is_delta;
1082                 } packed;
1083         } u;
1084 };
1085 extern int sha1_object_info_extended(const unsigned char *, struct object_info *);
1086
1087 /* Dumb servers support */
1088 extern int update_server_info(int);
1089
1090 /* git_config_parse_key() returns these negated: */
1091 #define CONFIG_INVALID_KEY 1
1092 #define CONFIG_NO_SECTION_OR_NAME 2
1093 /* git_config_set(), git_config_set_multivar() return the above or these: */
1094 #define CONFIG_NO_LOCK -1
1095 #define CONFIG_INVALID_FILE 3
1096 #define CONFIG_NO_WRITE 4
1097 #define CONFIG_NOTHING_SET 5
1098 #define CONFIG_INVALID_PATTERN 6
1099 #define CONFIG_GENERIC_ERROR 7
1100
1101 typedef int (*config_fn_t)(const char *, const char *, void *);
1102 extern int git_default_config(const char *, const char *, void *);
1103 extern int git_config_from_file(config_fn_t fn, const char *, void *);
1104 extern void git_config_push_parameter(const char *text);
1105 extern int git_config_from_parameters(config_fn_t fn, void *data);
1106 extern int git_config(config_fn_t fn, void *);
1107 extern int git_config_with_options(config_fn_t fn, void *,
1108                                    const char *filename, int respect_includes);
1109 extern int git_config_early(config_fn_t fn, void *, const char *repo_config);
1110 extern int git_parse_ulong(const char *, unsigned long *);
1111 extern int git_config_int(const char *, const char *);
1112 extern unsigned long git_config_ulong(const char *, const char *);
1113 extern int git_config_bool_or_int(const char *, const char *, int *);
1114 extern int git_config_bool(const char *, const char *);
1115 extern int git_config_maybe_bool(const char *, const char *);
1116 extern int git_config_string(const char **, const char *, const char *);
1117 extern int git_config_pathname(const char **, const char *, const char *);
1118 extern int git_config_set_in_file(const char *, const char *, const char *);
1119 extern int git_config_set(const char *, const char *);
1120 extern int git_config_parse_key(const char *, char **, int *);
1121 extern int git_config_set_multivar(const char *, const char *, const char *, int);
1122 extern int git_config_set_multivar_in_file(const char *, const char *, const char *, const char *, int);
1123 extern int git_config_rename_section(const char *, const char *);
1124 extern int git_config_rename_section_in_file(const char *, const char *, const char *);
1125 extern const char *git_etc_gitconfig(void);
1126 extern int check_repository_format_version(const char *var, const char *value, void *cb);
1127 extern int git_env_bool(const char *, int);
1128 extern int git_config_system(void);
1129 extern int config_error_nonbool(const char *);
1130 extern const char *get_log_output_encoding(void);
1131 extern const char *get_commit_output_encoding(void);
1132
1133 extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
1134
1135 struct config_include_data {
1136         int depth;
1137         config_fn_t fn;
1138         void *data;
1139 };
1140 #define CONFIG_INCLUDE_INIT { 0 }
1141 extern int git_config_include(const char *name, const char *value, void *data);
1142
1143 extern int committer_ident_sufficiently_given(void);
1144 extern int author_ident_sufficiently_given(void);
1145
1146 extern const char *git_commit_encoding;
1147 extern const char *git_log_output_encoding;
1148 extern const char *git_mailmap_file;
1149
1150 /* IO helper functions */
1151 extern void maybe_flush_or_die(FILE *, const char *);
1152 extern int copy_fd(int ifd, int ofd);
1153 extern int copy_file(const char *dst, const char *src, int mode);
1154 extern int copy_file_with_time(const char *dst, const char *src, int mode);
1155 extern void write_or_die(int fd, const void *buf, size_t count);
1156 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
1157 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
1158 extern void fsync_or_die(int fd, const char *);
1159
1160 extern ssize_t read_in_full(int fd, void *buf, size_t count);
1161 extern ssize_t write_in_full(int fd, const void *buf, size_t count);
1162 static inline ssize_t write_str_in_full(int fd, const char *str)
1163 {
1164         return write_in_full(fd, str, strlen(str));
1165 }
1166
1167 /* pager.c */
1168 extern void setup_pager(void);
1169 extern const char *pager_program;
1170 extern int pager_in_use(void);
1171 extern int pager_use_color;
1172 extern int term_columns(void);
1173 extern int decimal_width(int);
1174 extern int check_pager_config(const char *cmd);
1175
1176 extern const char *editor_program;
1177 extern const char *askpass_program;
1178 extern const char *excludes_file;
1179
1180 /* base85 */
1181 int decode_85(char *dst, const char *line, int linelen);
1182 void encode_85(char *buf, const unsigned char *data, int bytes);
1183
1184 /* alloc.c */
1185 extern void *alloc_blob_node(void);
1186 extern void *alloc_tree_node(void);
1187 extern void *alloc_commit_node(void);
1188 extern void *alloc_tag_node(void);
1189 extern void *alloc_object_node(void);
1190 extern void alloc_report(void);
1191
1192 /* trace.c */
1193 __attribute__((format (printf, 1, 2)))
1194 extern void trace_printf(const char *format, ...);
1195 __attribute__((format (printf, 2, 3)))
1196 extern void trace_argv_printf(const char **argv, const char *format, ...);
1197 extern void trace_repo_setup(const char *prefix);
1198 extern int trace_want(const char *key);
1199 extern void trace_strbuf(const char *key, const struct strbuf *buf);
1200
1201 void packet_trace_identity(const char *prog);
1202
1203 /* add */
1204 /*
1205  * return 0 if success, 1 - if addition of a file failed and
1206  * ADD_FILES_IGNORE_ERRORS was specified in flags
1207  */
1208 int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
1209
1210 /* diff.c */
1211 extern int diff_auto_refresh_index;
1212
1213 /* match-trees.c */
1214 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
1215 void shift_tree_by(const unsigned char *, const unsigned char *, unsigned char *, const char *);
1216
1217 /*
1218  * whitespace rules.
1219  * used by both diff and apply
1220  * last two digits are tab width
1221  */
1222 #define WS_BLANK_AT_EOL         0100
1223 #define WS_SPACE_BEFORE_TAB     0200
1224 #define WS_INDENT_WITH_NON_TAB  0400
1225 #define WS_CR_AT_EOL           01000
1226 #define WS_BLANK_AT_EOF        02000
1227 #define WS_TAB_IN_INDENT       04000
1228 #define WS_TRAILING_SPACE      (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
1229 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
1230 #define WS_TAB_WIDTH_MASK        077
1231 extern unsigned whitespace_rule_cfg;
1232 extern unsigned whitespace_rule(const char *);
1233 extern unsigned parse_whitespace_rule(const char *);
1234 extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
1235 extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
1236 extern char *whitespace_error_string(unsigned ws);
1237 extern void ws_fix_copy(struct strbuf *, const char *, int, unsigned, int *);
1238 extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
1239 #define ws_tab_width(rule)     ((rule) & WS_TAB_WIDTH_MASK)
1240
1241 /* ls-files */
1242 int report_path_error(const char *ps_matched, const char **pathspec, const char *prefix);
1243 void overlay_tree_on_cache(const char *tree_name, const char *prefix);
1244
1245 char *alias_lookup(const char *alias);
1246 int split_cmdline(char *cmdline, const char ***argv);
1247 /* Takes a negative value returned by split_cmdline */
1248 const char *split_cmdline_strerror(int cmdline_errno);
1249
1250 /* git.c */
1251 struct startup_info {
1252         int have_repository;
1253         const char *prefix;
1254 };
1255 extern struct startup_info *startup_info;
1256
1257 /* merge.c */
1258 struct commit_list;
1259 int try_merge_command(const char *strategy, size_t xopts_nr,
1260                 const char **xopts, struct commit_list *common,
1261                 const char *head_arg, struct commit_list *remotes);
1262 int checkout_fast_forward(const unsigned char *from,
1263                           const unsigned char *to,
1264                           int overwrite_ignore);
1265
1266
1267 int sane_execvp(const char *file, char *const argv[]);
1268
1269 #endif /* CACHE_H */