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