Andrew's git - gitweb.git/blob

   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" */
  80struct 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 */
  91struct 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 */
 104struct 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
 118struct 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)
 153static 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
 164static 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
 171static 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)
 186static 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}
 194static 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}
 207static 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
 226struct 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
 237extern struct index_state the_index;
 238
 239/* Name hashing */
 240extern 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 */
 250static 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_preload(pathspec) read_index_preload(&the_index, (pathspec))
 266#define is_cache_unborn() is_index_unborn(&the_index)
 267#define read_cache_unmerged() read_index_unmerged(&the_index)
 268#define write_cache(newfd, cache, entries) write_index(&the_index, (newfd))
 269#define discard_cache() discard_index(&the_index)
 270#define unmerged_cache() unmerged_index(&the_index)
 271#define cache_name_pos(name, namelen) index_name_pos(&the_index,(name),(namelen))
 272#define add_cache_entry(ce, option) add_index_entry(&the_index, (ce), (option))
 273#define rename_cache_entry_at(pos, new_name) rename_index_entry_at(&the_index, (pos), (new_name))
 274#define remove_cache_entry_at(pos) remove_index_entry_at(&the_index, (pos))
 275#define remove_file_from_cache(path) remove_file_from_index(&the_index, (path))
 276#define add_to_cache(path, st, flags) add_to_index(&the_index, (path), (st), (flags))
 277#define add_file_to_cache(path, flags) add_file_to_index(&the_index, (path), (flags))
 278#define refresh_cache(flags) refresh_index(&the_index, (flags), NULL, NULL)
 279#define ce_match_stat(ce, st, options) ie_match_stat(&the_index, (ce), (st), (options))
 280#define ce_modified(ce, st, options) ie_modified(&the_index, (ce), (st), (options))
 281#define cache_name_exists(name, namelen, igncase) index_name_exists(&the_index, (name), (namelen), (igncase))
 282#define cache_name_is_other(name, namelen) index_name_is_other(&the_index, (name), (namelen))
 283#endif
 284
 285enum object_type {
 286        OBJ_BAD = -1,
 287        OBJ_NONE = 0,
 288        OBJ_COMMIT = 1,
 289        OBJ_TREE = 2,
 290        OBJ_BLOB = 3,
 291        OBJ_TAG = 4,
 292        /* 5 for future expansion */
 293        OBJ_OFS_DELTA = 6,
 294        OBJ_REF_DELTA = 7,
 295        OBJ_ANY,
 296        OBJ_MAX,
 297};
 298
 299static inline enum object_type object_type(unsigned int mode)
 300{
 301        return S_ISDIR(mode) ? OBJ_TREE :
 302                S_ISGITLINK(mode) ? OBJ_COMMIT :
 303                OBJ_BLOB;
 304}
 305
 306#define GIT_DIR_ENVIRONMENT "GIT_DIR"
 307#define GIT_WORK_TREE_ENVIRONMENT "GIT_WORK_TREE"
 308#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
 309#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
 310#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
 311#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
 312#define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
 313#define CONFIG_ENVIRONMENT "GIT_CONFIG"
 314#define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
 315#define CEILING_DIRECTORIES_ENVIRONMENT "GIT_CEILING_DIRECTORIES"
 316#define GITATTRIBUTES_FILE ".gitattributes"
 317#define INFOATTRIBUTES_FILE "info/attributes"
 318#define ATTRIBUTE_MACRO_PREFIX "[attr]"
 319
 320extern int is_bare_repository_cfg;
 321extern int is_bare_repository(void);
 322extern int is_inside_git_dir(void);
 323extern char *git_work_tree_cfg;
 324extern int is_inside_work_tree(void);
 325extern int have_git_dir(void);
 326extern const char *get_git_dir(void);
 327extern char *get_object_directory(void);
 328extern char *get_index_file(void);
 329extern char *get_graft_file(void);
 330extern int set_git_dir(const char *path);
 331extern const char *get_git_work_tree(void);
 332extern const char *read_gitfile_gently(const char *path);
 333extern void set_git_work_tree(const char *tree);
 334
 335#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
 336
 337extern const char **get_pathspec(const char *prefix, const char **pathspec);
 338extern void setup_work_tree(void);
 339extern const char *setup_git_directory_gently(int *);
 340extern const char *setup_git_directory(void);
 341extern const char *prefix_path(const char *prefix, int len, const char *path);
 342extern const char *prefix_filename(const char *prefix, int len, const char *path);
 343extern void verify_filename(const char *prefix, const char *name);
 344extern void verify_non_filename(const char *prefix, const char *name);
 345
 346#define INIT_DB_QUIET 0x0001
 347
 348extern int init_db(const char *template_dir, unsigned int flags);
 349
 350#define alloc_nr(x) (((x)+16)*3/2)
 351
 352/*
 353 * Realloc the buffer pointed at by variable 'x' so that it can hold
 354 * at least 'nr' entries; the number of entries currently allocated
 355 * is 'alloc', using the standard growing factor alloc_nr() macro.
 356 *
 357 * DO NOT USE any expression with side-effect for 'x' or 'alloc'.
 358 */
 359#define ALLOC_GROW(x, nr, alloc) \
 360        do { \
 361                if ((nr) > alloc) { \
 362                        if (alloc_nr(alloc) < (nr)) \
 363                                alloc = (nr); \
 364                        else \
 365                                alloc = alloc_nr(alloc); \
 366                        x = xrealloc((x), alloc * sizeof(*(x))); \
 367                } \
 368        } while(0)
 369
 370/* Initialize and use the cache information */
 371extern int read_index(struct index_state *);
 372extern int read_index_preload(struct index_state *, const char **pathspec);
 373extern int read_index_from(struct index_state *, const char *path);
 374extern int is_index_unborn(struct index_state *);
 375extern int read_index_unmerged(struct index_state *);
 376extern int write_index(const struct index_state *, int newfd);
 377extern int discard_index(struct index_state *);
 378extern int unmerged_index(const struct index_state *);
 379extern int verify_path(const char *path);
 380extern struct cache_entry *index_name_exists(struct index_state *istate, const char *name, int namelen, int igncase);
 381extern int index_name_pos(const struct index_state *, const char *name, int namelen);
 382#define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
 383#define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
 384#define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
 385#define ADD_CACHE_JUST_APPEND 8         /* Append only; tree.c::read_tree() */
 386#define ADD_CACHE_NEW_ONLY 16           /* Do not replace existing ones */
 387extern int add_index_entry(struct index_state *, struct cache_entry *ce, int option);
 388extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
 389extern void rename_index_entry_at(struct index_state *, int pos, const char *new_name);
 390extern int remove_index_entry_at(struct index_state *, int pos);
 391extern int remove_file_from_index(struct index_state *, const char *path);
 392#define ADD_CACHE_VERBOSE 1
 393#define ADD_CACHE_PRETEND 2
 394#define ADD_CACHE_IGNORE_ERRORS 4
 395#define ADD_CACHE_IGNORE_REMOVAL 8
 396#define ADD_CACHE_INTENT 16
 397extern int add_to_index(struct index_state *, const char *path, struct stat *, int flags);
 398extern int add_file_to_index(struct index_state *, const char *path, int flags);
 399extern struct cache_entry *make_cache_entry(unsigned int mode, const unsigned char *sha1, const char *path, int stage, int refresh);
 400extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
 401extern int index_name_is_other(const struct index_state *, const char *, int);
 402
 403/* do stat comparison even if CE_VALID is true */
 404#define CE_MATCH_IGNORE_VALID           01
 405/* do not check the contents but report dirty on racily-clean entries */
 406#define CE_MATCH_RACY_IS_DIRTY  02
 407extern int ie_match_stat(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
 408extern int ie_modified(const struct index_state *, struct cache_entry *, struct stat *, unsigned int);
 409
 410extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
 411extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
 412extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
 413extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
 414
 415#define REFRESH_REALLY          0x0001  /* ignore_valid */
 416#define REFRESH_UNMERGED        0x0002  /* allow unmerged */
 417#define REFRESH_QUIET           0x0004  /* be quiet about it */
 418#define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
 419#define REFRESH_IGNORE_SUBMODULES       0x0010  /* ignore submodules */
 420#define REFRESH_SAY_CHANGED     0x0020  /* say "changed" not "needs update" */
 421extern int refresh_index(struct index_state *, unsigned int flags, const char **pathspec, char *seen);
 422
 423struct lock_file {
 424        struct lock_file *next;
 425        int fd;
 426        pid_t owner;
 427        char on_list;
 428        char filename[PATH_MAX];
 429};
 430#define LOCK_DIE_ON_ERROR 1
 431#define LOCK_NODEREF 2
 432extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
 433extern int hold_lock_file_for_append(struct lock_file *, const char *path, int);
 434extern int commit_lock_file(struct lock_file *);
 435
 436extern int hold_locked_index(struct lock_file *, int);
 437extern int commit_locked_index(struct lock_file *);
 438extern void set_alternate_index_output(const char *);
 439extern int close_lock_file(struct lock_file *);
 440extern void rollback_lock_file(struct lock_file *);
 441extern int delete_ref(const char *, const unsigned char *sha1, int delopt);
 442
 443/* Environment bits from configuration mechanism */
 444extern int trust_executable_bit;
 445extern int trust_ctime;
 446extern int quote_path_fully;
 447extern int has_symlinks;
 448extern int ignore_case;
 449extern int assume_unchanged;
 450extern int prefer_symlink_refs;
 451extern int log_all_ref_updates;
 452extern int warn_ambiguous_refs;
 453extern int shared_repository;
 454extern const char *apply_default_whitespace;
 455extern int zlib_compression_level;
 456extern int core_compression_level;
 457extern int core_compression_seen;
 458extern size_t packed_git_window_size;
 459extern size_t packed_git_limit;
 460extern size_t delta_base_cache_limit;
 461extern int auto_crlf;
 462extern int fsync_object_files;
 463extern int core_preload_index;
 464
 465enum safe_crlf {
 466        SAFE_CRLF_FALSE = 0,
 467        SAFE_CRLF_FAIL = 1,
 468        SAFE_CRLF_WARN = 2,
 469};
 470
 471extern enum safe_crlf safe_crlf;
 472
 473enum branch_track {
 474        BRANCH_TRACK_UNSPECIFIED = -1,
 475        BRANCH_TRACK_NEVER = 0,
 476        BRANCH_TRACK_REMOTE,
 477        BRANCH_TRACK_ALWAYS,
 478        BRANCH_TRACK_EXPLICIT,
 479};
 480
 481enum rebase_setup_type {
 482        AUTOREBASE_NEVER = 0,
 483        AUTOREBASE_LOCAL,
 484        AUTOREBASE_REMOTE,
 485        AUTOREBASE_ALWAYS,
 486};
 487
 488extern enum branch_track git_branch_track;
 489extern enum rebase_setup_type autorebase;
 490
 491#define GIT_REPO_VERSION 0
 492extern int repository_format_version;
 493extern int check_repository_format(void);
 494
 495#define MTIME_CHANGED   0x0001
 496#define CTIME_CHANGED   0x0002
 497#define OWNER_CHANGED   0x0004
 498#define MODE_CHANGED    0x0008
 499#define INODE_CHANGED   0x0010
 500#define DATA_CHANGED    0x0020
 501#define TYPE_CHANGED    0x0040
 502
 503extern char *mksnpath(char *buf, size_t n, const char *fmt, ...)
 504        __attribute__((format (printf, 3, 4)));
 505extern char *git_snpath(char *buf, size_t n, const char *fmt, ...)
 506        __attribute__((format (printf, 3, 4)));
 507extern char *git_pathdup(const char *fmt, ...)
 508        __attribute__((format (printf, 1, 2)));
 509
 510/* Return a statically allocated filename matching the sha1 signature */
 511extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 512extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 513extern char *sha1_file_name(const unsigned char *sha1);
 514extern char *sha1_pack_name(const unsigned char *sha1);
 515extern char *sha1_pack_index_name(const unsigned char *sha1);
 516extern const char *find_unique_abbrev(const unsigned char *sha1, int);
 517extern const unsigned char null_sha1[20];
 518static inline int is_null_sha1(const unsigned char *sha1)
 519{
 520        return !memcmp(sha1, null_sha1, 20);
 521}
 522static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
 523{
 524        return memcmp(sha1, sha2, 20);
 525}
 526static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
 527{
 528        memcpy(sha_dst, sha_src, 20);
 529}
 530static inline void hashclr(unsigned char *hash)
 531{
 532        memset(hash, 0, 20);
 533}
 534extern int is_empty_blob_sha1(const unsigned char *sha1);
 535
 536#define EMPTY_TREE_SHA1_HEX \
 537        "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
 538#define EMPTY_TREE_SHA1_BIN \
 539         "\x4b\x82\x5d\xc6\x42\xcb\x6e\xb9\xa0\x60" \
 540         "\xe5\x4b\xf8\xd6\x92\x88\xfb\xee\x49\x04"
 541
 542int git_mkstemp(char *path, size_t n, const char *template);
 543
 544/*
 545 * NOTE NOTE NOTE!!
 546 *
 547 * PERM_UMASK, OLD_PERM_GROUP and OLD_PERM_EVERYBODY enumerations must
 548 * not be changed. Old repositories have core.sharedrepository written in
 549 * numeric format, and therefore these values are preserved for compatibility
 550 * reasons.
 551 */
 552enum sharedrepo {
 553        PERM_UMASK          = 0,
 554        OLD_PERM_GROUP      = 1,
 555        OLD_PERM_EVERYBODY  = 2,
 556        PERM_GROUP          = 0660,
 557        PERM_EVERYBODY      = 0664,
 558};
 559int git_config_perm(const char *var, const char *value);
 560int adjust_shared_perm(const char *path);
 561int safe_create_leading_directories(char *path);
 562int safe_create_leading_directories_const(const char *path);
 563char *enter_repo(char *path, int strict);
 564static inline int is_absolute_path(const char *path)
 565{
 566        return path[0] == '/' || has_dos_drive_prefix(path);
 567}
 568int is_directory(const char *);
 569const char *make_absolute_path(const char *path);
 570const char *make_nonrelative_path(const char *path);
 571const char *make_relative_path(const char *abs, const char *base);
 572int normalize_absolute_path(char *buf, const char *path);
 573int longest_ancestor_length(const char *path, const char *prefix_list);
 574
 575/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
 576extern int sha1_object_info(const unsigned char *, unsigned long *);
 577extern void * read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size);
 578extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
 579extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
 580extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
 581extern int force_object_loose(const unsigned char *sha1, time_t mtime);
 582
 583/* just like read_sha1_file(), but non fatal in presence of bad objects */
 584extern void *read_object(const unsigned char *sha1, enum object_type *type, unsigned long *size);
 585
 586/* global flag to enable extra checks when accessing packed objects */
 587extern int do_check_packed_object_crc;
 588
 589extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
 590
 591extern int move_temp_to_file(const char *tmpfile, const char *filename);
 592
 593extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
 594extern int has_sha1_file(const unsigned char *sha1);
 595extern int has_loose_object_nonlocal(const unsigned char *sha1);
 596
 597extern int has_pack_file(const unsigned char *sha1);
 598extern int has_pack_index(const unsigned char *sha1);
 599
 600extern const signed char hexval_table[256];
 601static inline unsigned int hexval(unsigned char c)
 602{
 603        return hexval_table[c];
 604}
 605
 606/* Convert to/from hex/sha1 representation */
 607#define MINIMUM_ABBREV 4
 608#define DEFAULT_ABBREV 7
 609
 610extern int get_sha1(const char *str, unsigned char *sha1);
 611extern int get_sha1_with_mode(const char *str, unsigned char *sha1, unsigned *mode);
 612extern int get_sha1_hex(const char *hex, unsigned char *sha1);
 613extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
 614extern int read_ref(const char *filename, unsigned char *sha1);
 615extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
 616extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
 617extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
 618
 619extern int refname_match(const char *abbrev_name, const char *full_name, const char **rules);
 620extern const char *ref_rev_parse_rules[];
 621extern const char *ref_fetch_rules[];
 622
 623extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
 624extern int validate_headref(const char *ref);
 625
 626extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
 627extern int df_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
 628extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
 629
 630extern void *read_object_with_reference(const unsigned char *sha1,
 631                                        const char *required_type,
 632                                        unsigned long *size,
 633                                        unsigned char *sha1_ret);
 634
 635extern struct object *peel_to_type(const char *name, int namelen,
 636                                   struct object *o, enum object_type);
 637
 638enum date_mode {
 639        DATE_NORMAL = 0,
 640        DATE_RELATIVE,
 641        DATE_SHORT,
 642        DATE_LOCAL,
 643        DATE_ISO8601,
 644        DATE_RFC2822
 645};
 646
 647const char *show_date(unsigned long time, int timezone, enum date_mode mode);
 648int parse_date(const char *date, char *buf, int bufsize);
 649void datestamp(char *buf, int bufsize);
 650unsigned long approxidate(const char *);
 651enum date_mode parse_date_format(const char *format);
 652
 653#define IDENT_WARN_ON_NO_NAME  1
 654#define IDENT_ERROR_ON_NO_NAME 2
 655#define IDENT_NO_DATE          4
 656extern const char *git_author_info(int);
 657extern const char *git_committer_info(int);
 658extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
 659extern const char *fmt_name(const char *name, const char *email);
 660
 661struct checkout {
 662        const char *base_dir;
 663        int base_dir_len;
 664        unsigned force:1,
 665                 quiet:1,
 666                 not_new:1,
 667                 refresh_cache:1;
 668};
 669
 670extern int checkout_entry(struct cache_entry *ce, const struct checkout *state, char *topath);
 671extern int has_symlink_leading_path(int len, const char *name);
 672
 673extern struct alternate_object_database {
 674        struct alternate_object_database *next;
 675        char *name;
 676        char base[FLEX_ARRAY]; /* more */
 677} *alt_odb_list;
 678extern void prepare_alt_odb(void);
 679extern void add_to_alternates_file(const char *reference);
 680typedef int alt_odb_fn(struct alternate_object_database *, void *);
 681extern void foreach_alt_odb(alt_odb_fn, void*);
 682
 683struct pack_window {
 684        struct pack_window *next;
 685        unsigned char *base;
 686        off_t offset;
 687        size_t len;
 688        unsigned int last_used;
 689        unsigned int inuse_cnt;
 690};
 691
 692extern struct packed_git {
 693        struct packed_git *next;
 694        struct pack_window *windows;
 695        off_t pack_size;
 696        const void *index_data;
 697        size_t index_size;
 698        uint32_t num_objects;
 699        uint32_t num_bad_objects;
 700        unsigned char *bad_object_sha1;
 701        int index_version;
 702        time_t mtime;
 703        int pack_fd;
 704        unsigned pack_local:1,
 705                 pack_keep:1;
 706        unsigned char sha1[20];
 707        /* something like ".git/objects/pack/xxxxx.pack" */
 708        char pack_name[FLEX_ARRAY]; /* more */
 709} *packed_git;
 710
 711struct pack_entry {
 712        off_t offset;
 713        unsigned char sha1[20];
 714        struct packed_git *p;
 715};
 716
 717struct ref {
 718        struct ref *next;
 719        unsigned char old_sha1[20];
 720        unsigned char new_sha1[20];
 721        char *symref;
 722        unsigned int force:1,
 723                merge:1,
 724                nonfastforward:1,
 725                deletion:1;
 726        enum {
 727                REF_STATUS_NONE = 0,
 728                REF_STATUS_OK,
 729                REF_STATUS_REJECT_NONFASTFORWARD,
 730                REF_STATUS_REJECT_NODELETE,
 731                REF_STATUS_UPTODATE,
 732                REF_STATUS_REMOTE_REJECT,
 733                REF_STATUS_EXPECTING_REPORT,
 734        } status;
 735        char *remote_status;
 736        struct ref *peer_ref; /* when renaming */
 737        char name[FLEX_ARRAY]; /* more */
 738};
 739
 740#define REF_NORMAL      (1u << 0)
 741#define REF_HEADS       (1u << 1)
 742#define REF_TAGS        (1u << 2)
 743
 744extern struct ref *find_ref_by_name(struct ref *list, const char *name);
 745
 746#define CONNECT_VERBOSE       (1u << 0)
 747extern struct child_process *git_connect(int fd[2], const char *url, const char *prog, int flags);
 748extern int finish_connect(struct child_process *conn);
 749extern int path_match(const char *path, int nr, char **match);
 750extern int get_ack(int fd, unsigned char *result_sha1);
 751struct extra_have_objects {
 752        int nr, alloc;
 753        unsigned char (*array)[20];
 754};
 755extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags, struct extra_have_objects *);
 756extern int server_supports(const char *feature);
 757
 758extern struct packed_git *parse_pack_index(unsigned char *sha1);
 759
 760extern void prepare_packed_git(void);
 761extern void reprepare_packed_git(void);
 762extern void install_packed_git(struct packed_git *pack);
 763
 764extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
 765                                         struct packed_git *packs);
 766
 767extern void pack_report(void);
 768extern int open_pack_index(struct packed_git *);
 769extern unsigned char* use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
 770extern void close_pack_windows(struct packed_git *);
 771extern void unuse_pack(struct pack_window **);
 772extern struct packed_git *add_packed_git(const char *, int, int);
 773extern const unsigned char *nth_packed_object_sha1(struct packed_git *, uint32_t);
 774extern off_t nth_packed_object_offset(const struct packed_git *, uint32_t);
 775extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
 776extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
 777extern unsigned long unpack_object_header_buffer(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
 778extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
 779extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
 780extern int matches_pack_name(struct packed_git *p, const char *name);
 781
 782/* Dumb servers support */
 783extern int update_server_info(int);
 784
 785typedef int (*config_fn_t)(const char *, const char *, void *);
 786extern int git_default_config(const char *, const char *, void *);
 787extern int git_config_from_file(config_fn_t fn, const char *, void *);
 788extern int git_config(config_fn_t fn, void *);
 789extern int git_parse_ulong(const char *, unsigned long *);
 790extern int git_config_int(const char *, const char *);
 791extern unsigned long git_config_ulong(const char *, const char *);
 792extern int git_config_bool_or_int(const char *, const char *, int *);
 793extern int git_config_bool(const char *, const char *);
 794extern int git_config_string(const char **, const char *, const char *);
 795extern int git_config_set(const char *, const char *);
 796extern int git_config_set_multivar(const char *, const char *, const char *, int);
 797extern int git_config_rename_section(const char *, const char *);
 798extern const char *git_etc_gitconfig(void);
 799extern int check_repository_format_version(const char *var, const char *value, void *cb);
 800extern int git_config_system(void);
 801extern int git_config_global(void);
 802extern int config_error_nonbool(const char *);
 803extern const char *config_exclusive_filename;
 804
 805#define MAX_GITNAME (1000)
 806extern char git_default_email[MAX_GITNAME];
 807extern char git_default_name[MAX_GITNAME];
 808extern int user_ident_explicitly_given;
 809
 810extern const char *git_commit_encoding;
 811extern const char *git_log_output_encoding;
 812
 813/* IO helper functions */
 814extern void maybe_flush_or_die(FILE *, const char *);
 815extern int copy_fd(int ifd, int ofd);
 816extern int copy_file(const char *dst, const char *src, int mode);
 817extern ssize_t read_in_full(int fd, void *buf, size_t count);
 818extern ssize_t write_in_full(int fd, const void *buf, size_t count);
 819extern void write_or_die(int fd, const void *buf, size_t count);
 820extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
 821extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
 822extern void fsync_or_die(int fd, const char *);
 823
 824/* pager.c */
 825extern void setup_pager(void);
 826extern const char *pager_program;
 827extern int pager_in_use(void);
 828extern int pager_use_color;
 829
 830extern const char *editor_program;
 831extern const char *excludes_file;
 832
 833/* base85 */
 834int decode_85(char *dst, const char *line, int linelen);
 835void encode_85(char *buf, const unsigned char *data, int bytes);
 836
 837/* alloc.c */
 838extern void *alloc_blob_node(void);
 839extern void *alloc_tree_node(void);
 840extern void *alloc_commit_node(void);
 841extern void *alloc_tag_node(void);
 842extern void *alloc_object_node(void);
 843extern void alloc_report(void);
 844
 845/* trace.c */
 846extern void trace_printf(const char *format, ...);
 847extern void trace_argv_printf(const char **argv, const char *format, ...);
 848
 849/* convert.c */
 850/* returns 1 if *dst was used */
 851extern int convert_to_git(const char *path, const char *src, size_t len,
 852                          struct strbuf *dst, enum safe_crlf checksafe);
 853extern int convert_to_working_tree(const char *path, const char *src, size_t len, struct strbuf *dst);
 854
 855/* add */
 856/*
 857 * return 0 if success, 1 - if addition of a file failed and
 858 * ADD_FILES_IGNORE_ERRORS was specified in flags
 859 */
 860int add_files_to_cache(const char *prefix, const char **pathspec, int flags);
 861
 862/* diff.c */
 863extern int diff_auto_refresh_index;
 864
 865/* match-trees.c */
 866void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
 867
 868/*
 869 * whitespace rules.
 870 * used by both diff and apply
 871 */
 872#define WS_TRAILING_SPACE       01
 873#define WS_SPACE_BEFORE_TAB     02
 874#define WS_INDENT_WITH_NON_TAB  04
 875#define WS_CR_AT_EOL           010
 876#define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB)
 877extern unsigned whitespace_rule_cfg;
 878extern unsigned whitespace_rule(const char *);
 879extern unsigned parse_whitespace_rule(const char *);
 880extern unsigned ws_check(const char *line, int len, unsigned ws_rule);
 881extern void ws_check_emit(const char *line, int len, unsigned ws_rule, FILE *stream, const char *set, const char *reset, const char *ws);
 882extern char *whitespace_error_string(unsigned ws);
 883extern int ws_fix_copy(char *, const char *, int, unsigned, int *);
 884extern int ws_blank_line(const char *line, int len, unsigned ws_rule);
 885
 886/* ls-files */
 887int pathspec_match(const char **spec, char *matched, const char *filename, int skiplen);
 888int report_path_error(const char *ps_matched, const char **pathspec, int prefix_offset);
 889void overlay_tree_on_cache(const char *tree_name, const char *prefix);
 890
 891char *alias_lookup(const char *alias);
 892int split_cmdline(char *cmdline, const char ***argv);
 893
 894#endif /* CACHE_H */