cache.h

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