cache.h

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