cache.h

   1 #ifndef CACHE_H
   2 #define CACHE_H
   3
   4 #include "git-compat-util.h"
   5
   6 #include SHA1_HEADER
   7 #include <zlib.h>
   8
   9 #if ZLIB_VERNUM < 0x1200
  10 #define deflateBound(c,s)  ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
  11 #endif
  12
  13 #if defined(DT_UNKNOWN) && !defined(NO_D_TYPE_IN_DIRENT)
  14 #define DTYPE(de)       ((de)->d_type)
  15 #else
  16 #undef DT_UNKNOWN
  17 #undef DT_DIR
  18 #undef DT_REG
  19 #undef DT_LNK
  20 #define DT_UNKNOWN      0
  21 #define DT_DIR          1
  22 #define DT_REG          2
  23 #define DT_LNK          3
  24 #define DTYPE(de)       DT_UNKNOWN
  25 #endif
  26
  27 /*
  28  * A "directory link" is a link to another git directory.
  29  *
  30  * The value 0160000 is not normally a valid mode, and
  31  * also just happens to be S_IFDIR + S_IFLNK
  32  *
  33  * NOTE! We *really* shouldn't depend on the S_IFxxx macros
  34  * always having the same values everywhere. We should use
  35  * our internal git values for these things, and then we can
  36  * translate that to the OS-specific value. It just so
  37  * happens that everybody shares the same bit representation
  38  * in the UNIX world (and apparently wider too..)
  39  */
  40 #define S_IFDIRLNK      0160000
  41 #define S_ISDIRLNK(m)   (((m) & S_IFMT) == S_IFDIRLNK)
  42
  43 /*
  44  * Intensive research over the course of many years has shown that
  45  * port 9418 is totally unused by anything else. Or
  46  *
  47  *      Your search - "port 9418" - did not match any documents.
  48  *
  49  * as www.google.com puts it.
  50  *
  51  * This port has been properly assigned for git use by IANA:
  52  * git (Assigned-9418) [I06-050728-0001].
  53  *
  54  *      git  9418/tcp   git pack transfer service
  55  *      git  9418/udp   git pack transfer service
  56  *
  57  * with Linus Torvalds <torvalds@osdl.org> as the point of
  58  * contact. September 2005.
  59  *
  60  * See http://www.iana.org/assignments/port-numbers
  61  */
  62 #define DEFAULT_GIT_PORT 9418
  63
  64 /*
  65  * Basic data structures for the directory cache
  66  */
  67
  68 #define CACHE_SIGNATURE 0x44495243      /* "DIRC" */
  69 struct cache_header {
  70         unsigned int hdr_signature;
  71         unsigned int hdr_version;
  72         unsigned int hdr_entries;
  73 };
  74
  75 /*
  76  * The "cache_time" is just the low 32 bits of the
  77  * time. It doesn't matter if it overflows - we only
  78  * check it for equality in the 32 bits we save.
  79  */
  80 struct cache_time {
  81         unsigned int sec;
  82         unsigned int nsec;
  83 };
  84
  85 /*
  86  * dev/ino/uid/gid/size are also just tracked to the low 32 bits
  87  * Again - this is just a (very strong in practice) heuristic that
  88  * the inode hasn't changed.
  89  *
  90  * We save the fields in big-endian order to allow using the
  91  * index file over NFS transparently.
  92  */
  93 struct cache_entry {
  94         struct cache_time ce_ctime;
  95         struct cache_time ce_mtime;
  96         unsigned int ce_dev;
  97         unsigned int ce_ino;
  98         unsigned int ce_mode;
  99         unsigned int ce_uid;
 100         unsigned int ce_gid;
 101         unsigned int ce_size;
 102         unsigned char sha1[20];
 103         unsigned short ce_flags;
 104         char name[FLEX_ARRAY]; /* more */
 105 };
 106
 107 #define CE_NAMEMASK  (0x0fff)
 108 #define CE_STAGEMASK (0x3000)
 109 #define CE_UPDATE    (0x4000)
 110 #define CE_VALID     (0x8000)
 111 #define CE_STAGESHIFT 12
 112
 113 #define create_ce_flags(len, stage) htons((len) | ((stage) << CE_STAGESHIFT))
 114 #define ce_namelen(ce) (CE_NAMEMASK & ntohs((ce)->ce_flags))
 115 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
 116 #define ce_stage(ce) ((CE_STAGEMASK & ntohs((ce)->ce_flags)) >> CE_STAGESHIFT)
 117
 118 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
 119 static inline unsigned int create_ce_mode(unsigned int mode)
 120 {
 121         if (S_ISLNK(mode))
 122                 return htonl(S_IFLNK);
 123         if (S_ISDIR(mode) || S_ISDIRLNK(mode))
 124                 return htonl(S_IFDIRLNK);
 125         return htonl(S_IFREG | ce_permissions(mode));
 126 }
 127 static inline unsigned int ce_mode_from_stat(struct cache_entry *ce, unsigned int mode)
 128 {
 129         extern int trust_executable_bit, has_symlinks;
 130         if (!has_symlinks && S_ISREG(mode) &&
 131             ce && S_ISLNK(ntohl(ce->ce_mode)))
 132                 return ce->ce_mode;
 133         if (!trust_executable_bit && S_ISREG(mode)) {
 134                 if (ce && S_ISREG(ntohl(ce->ce_mode)))
 135                         return ce->ce_mode;
 136                 return create_ce_mode(0666);
 137         }
 138         return create_ce_mode(mode);
 139 }
 140 #define canon_mode(mode) \
 141         (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
 142         S_ISLNK(mode) ? S_IFLNK : S_ISDIR(mode) ? S_IFDIR : S_IFDIRLNK)
 143
 144 #define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
 145
 146 struct index_state {
 147         struct cache_entry **cache;
 148         unsigned int cache_nr, cache_alloc, cache_changed;
 149         struct cache_tree *cache_tree;
 150         time_t timestamp;
 151         void *mmap;
 152         size_t mmap_size;
 153 };
 154
 155 extern struct index_state the_index;
 156
 157 #define active_cache (the_index.cache)
 158 #define active_nr (the_index.cache_nr)
 159 #define active_alloc (the_index.cache_alloc)
 160 #define active_cache_changed (the_index.cache_changed)
 161 #define active_cache_tree (the_index.cache_tree)
 162
 163 enum object_type {
 164         OBJ_BAD = -1,
 165         OBJ_NONE = 0,
 166         OBJ_COMMIT = 1,
 167         OBJ_TREE = 2,
 168         OBJ_BLOB = 3,
 169         OBJ_TAG = 4,
 170         /* 5 for future expansion */
 171         OBJ_OFS_DELTA = 6,
 172         OBJ_REF_DELTA = 7,
 173         OBJ_MAX,
 174 };
 175
 176 #define GIT_DIR_ENVIRONMENT "GIT_DIR"
 177 #define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
 178 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
 179 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
 180 #define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
 181 #define TEMPLATE_DIR_ENVIRONMENT "GIT_TEMPLATE_DIR"
 182 #define CONFIG_ENVIRONMENT "GIT_CONFIG"
 183 #define CONFIG_LOCAL_ENVIRONMENT "GIT_CONFIG_LOCAL"
 184 #define EXEC_PATH_ENVIRONMENT "GIT_EXEC_PATH"
 185 #define GITATTRIBUTES_FILE ".gitattributes"
 186 #define INFOATTRIBUTES_FILE "info/attributes"
 187 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
 188
 189 extern int is_bare_repository_cfg;
 190 extern int is_bare_repository(void);
 191 extern int is_inside_git_dir(void);
 192 extern const char *get_git_dir(void);
 193 extern char *get_object_directory(void);
 194 extern char *get_refs_directory(void);
 195 extern char *get_index_file(void);
 196 extern char *get_graft_file(void);
 197
 198 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
 199
 200 extern const char **get_pathspec(const char *prefix, const char **pathspec);
 201 extern const char *setup_git_directory_gently(int *);
 202 extern const char *setup_git_directory(void);
 203 extern const char *prefix_path(const char *prefix, int len, const char *path);
 204 extern const char *prefix_filename(const char *prefix, int len, const char *path);
 205 extern void verify_filename(const char *prefix, const char *name);
 206 extern void verify_non_filename(const char *prefix, const char *name);
 207
 208 #define alloc_nr(x) (((x)+16)*3/2)
 209
 210 /* Initialize and use the cache information */
 211 extern int read_cache(void);
 212 extern int read_cache_from(const char *path);
 213 extern int write_cache(int newfd, struct cache_entry **cache, int entries);
 214 extern int discard_cache(void);
 215 extern int verify_path(const char *path);
 216 extern int cache_name_pos(const char *name, int namelen);
 217 #define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
 218 #define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
 219 #define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
 220 extern int add_cache_entry(struct cache_entry *ce, int option);
 221 extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
 222 extern int remove_cache_entry_at(int pos);
 223 extern int remove_file_from_cache(const char *path);
 224 extern int add_file_to_cache(const char *path, int verbose);
 225 extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
 226 extern int ce_match_stat(struct cache_entry *ce, struct stat *st, int);
 227 extern int ce_modified(struct cache_entry *ce, struct stat *st, int);
 228 extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
 229 extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
 230 extern int read_pipe(int fd, char** return_buf, unsigned long* return_size);
 231 extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
 232 extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
 233 extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
 234
 235 #define REFRESH_REALLY          0x0001  /* ignore_valid */
 236 #define REFRESH_UNMERGED        0x0002  /* allow unmerged */
 237 #define REFRESH_QUIET           0x0004  /* be quiet about it */
 238 #define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
 239 extern int refresh_cache(unsigned int flags);
 240
 241 struct lock_file {
 242         struct lock_file *next;
 243         pid_t owner;
 244         char on_list;
 245         char filename[PATH_MAX];
 246 };
 247 extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
 248 extern int commit_lock_file(struct lock_file *);
 249
 250 extern int hold_locked_index(struct lock_file *, int);
 251 extern int commit_locked_index(struct lock_file *);
 252 extern void set_alternate_index_output(const char *);
 253
 254 extern void rollback_lock_file(struct lock_file *);
 255 extern int delete_ref(const char *, const unsigned char *sha1);
 256
 257 /* Environment bits from configuration mechanism */
 258 extern int use_legacy_headers;
 259 extern int trust_executable_bit;
 260 extern int has_symlinks;
 261 extern int assume_unchanged;
 262 extern int prefer_symlink_refs;
 263 extern int log_all_ref_updates;
 264 extern int warn_ambiguous_refs;
 265 extern int shared_repository;
 266 extern const char *apply_default_whitespace;
 267 extern int zlib_compression_level;
 268 extern size_t packed_git_window_size;
 269 extern size_t packed_git_limit;
 270 extern size_t delta_base_cache_limit;
 271 extern int auto_crlf;
 272
 273 #define GIT_REPO_VERSION 0
 274 extern int repository_format_version;
 275 extern int check_repository_format(void);
 276
 277 #define MTIME_CHANGED   0x0001
 278 #define CTIME_CHANGED   0x0002
 279 #define OWNER_CHANGED   0x0004
 280 #define MODE_CHANGED    0x0008
 281 #define INODE_CHANGED   0x0010
 282 #define DATA_CHANGED    0x0020
 283 #define TYPE_CHANGED    0x0040
 284
 285 /* Return a statically allocated filename matching the sha1 signature */
 286 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 287 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 288 extern char *sha1_file_name(const unsigned char *sha1);
 289 extern char *sha1_pack_name(const unsigned char *sha1);
 290 extern char *sha1_pack_index_name(const unsigned char *sha1);
 291 extern const char *find_unique_abbrev(const unsigned char *sha1, int);
 292 extern const unsigned char null_sha1[20];
 293 static inline int is_null_sha1(const unsigned char *sha1)
 294 {
 295         return !memcmp(sha1, null_sha1, 20);
 296 }
 297 static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
 298 {
 299         return memcmp(sha1, sha2, 20);
 300 }
 301 static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
 302 {
 303         memcpy(sha_dst, sha_src, 20);
 304 }
 305 static inline void hashclr(unsigned char *hash)
 306 {
 307         memset(hash, 0, 20);
 308 }
 309
 310 int git_mkstemp(char *path, size_t n, const char *template);
 311
 312 enum sharedrepo {
 313         PERM_UMASK = 0,
 314         PERM_GROUP,
 315         PERM_EVERYBODY
 316 };
 317 int git_config_perm(const char *var, const char *value);
 318 int adjust_shared_perm(const char *path);
 319 int safe_create_leading_directories(char *path);
 320 char *enter_repo(char *path, int strict);
 321
 322 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
 323 extern int sha1_object_info(const unsigned char *, unsigned long *);
 324 extern void * read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size);
 325 extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
 326 extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
 327 extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
 328
 329 extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
 330
 331 extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
 332                               size_t bufsize, size_t *bufposn);
 333 extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
 334 extern int move_temp_to_file(const char *tmpfile, const char *filename);
 335
 336 extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
 337 extern int has_sha1_file(const unsigned char *sha1);
 338 extern void *map_sha1_file(const unsigned char *sha1, unsigned long *);
 339 extern int legacy_loose_object(unsigned char *);
 340
 341 extern int has_pack_file(const unsigned char *sha1);
 342 extern int has_pack_index(const unsigned char *sha1);
 343
 344 extern signed char hexval_table[256];
 345 static inline unsigned int hexval(unsigned int c)
 346 {
 347         return hexval_table[c];
 348 }
 349
 350 /* Convert to/from hex/sha1 representation */
 351 #define MINIMUM_ABBREV 4
 352 #define DEFAULT_ABBREV 7
 353
 354 extern int get_sha1(const char *str, unsigned char *sha1);
 355 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
 356 extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
 357 extern int read_ref(const char *filename, unsigned char *sha1);
 358 extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
 359 extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
 360 extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
 361
 362 extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
 363 extern int validate_headref(const char *ref);
 364
 365 extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
 366 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
 367
 368 extern void *read_object_with_reference(const unsigned char *sha1,
 369                                         const char *required_type,
 370                                         unsigned long *size,
 371                                         unsigned char *sha1_ret);
 372
 373 enum date_mode { DATE_NORMAL = 0, DATE_RELATIVE, DATE_SHORT };
 374 const char *show_date(unsigned long time, int timezone, enum date_mode mode);
 375 const char *show_rfc2822_date(unsigned long time, int timezone);
 376 int parse_date(const char *date, char *buf, int bufsize);
 377 void datestamp(char *buf, int bufsize);
 378 unsigned long approxidate(const char *);
 379
 380 extern const char *git_author_info(int);
 381 extern const char *git_committer_info(int);
 382 extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
 383
 384 struct checkout {
 385         const char *base_dir;
 386         int base_dir_len;
 387         unsigned force:1,
 388                  quiet:1,
 389                  not_new:1,
 390                  refresh_cache:1;
 391 };
 392
 393 extern int checkout_entry(struct cache_entry *ce, struct checkout *state, char *topath);
 394
 395 extern struct alternate_object_database {
 396         struct alternate_object_database *next;
 397         char *name;
 398         char base[FLEX_ARRAY]; /* more */
 399 } *alt_odb_list;
 400 extern void prepare_alt_odb(void);
 401
 402 struct pack_window {
 403         struct pack_window *next;
 404         unsigned char *base;
 405         off_t offset;
 406         size_t len;
 407         unsigned int last_used;
 408         unsigned int inuse_cnt;
 409 };
 410
 411 extern struct packed_git {
 412         struct packed_git *next;
 413         struct pack_window *windows;
 414         off_t pack_size;
 415         const void *index_data;
 416         size_t index_size;
 417         uint32_t num_objects;
 418         int index_version;
 419         time_t mtime;
 420         int pack_fd;
 421         int pack_local;
 422         unsigned char sha1[20];
 423         /* something like ".git/objects/pack/xxxxx.pack" */
 424         char pack_name[FLEX_ARRAY]; /* more */
 425 } *packed_git;
 426
 427 struct pack_entry {
 428         off_t offset;
 429         unsigned char sha1[20];
 430         struct packed_git *p;
 431 };
 432
 433 struct ref {
 434         struct ref *next;
 435         unsigned char old_sha1[20];
 436         unsigned char new_sha1[20];
 437         unsigned char force;
 438         struct ref *peer_ref; /* when renaming */
 439         char name[FLEX_ARRAY]; /* more */
 440 };
 441
 442 #define REF_NORMAL      (1u << 0)
 443 #define REF_HEADS       (1u << 1)
 444 #define REF_TAGS        (1u << 2)
 445
 446 extern pid_t git_connect(int fd[2], char *url, const char *prog);
 447 extern int finish_connect(pid_t pid);
 448 extern int path_match(const char *path, int nr, char **match);
 449 extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
 450                       int nr_refspec, char **refspec, int all);
 451 extern int get_ack(int fd, unsigned char *result_sha1);
 452 extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags);
 453 extern int server_supports(const char *feature);
 454
 455 extern struct packed_git *parse_pack_index(unsigned char *sha1);
 456 extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
 457                                                 const char *idx_path);
 458
 459 extern void prepare_packed_git(void);
 460 extern void reprepare_packed_git(void);
 461 extern void install_packed_git(struct packed_git *pack);
 462
 463 extern struct packed_git *find_sha1_pack(const unsigned char *sha1,
 464                                          struct packed_git *packs);
 465
 466 extern void pack_report(void);
 467 extern unsigned char* use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
 468 extern void unuse_pack(struct pack_window **);
 469 extern struct packed_git *add_packed_git(const char *, int, int);
 470 extern const unsigned char *nth_packed_object_sha1(const struct packed_git *, uint32_t);
 471 extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
 472 extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
 473 extern unsigned long unpack_object_header_gently(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
 474 extern unsigned long get_size_from_delta(struct packed_git *, struct pack_window **, off_t);
 475 extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
 476
 477 /* Dumb servers support */
 478 extern int update_server_info(int);
 479
 480 typedef int (*config_fn_t)(const char *, const char *);
 481 extern int git_default_config(const char *, const char *);
 482 extern int git_config_from_file(config_fn_t fn, const char *);
 483 extern int git_config(config_fn_t fn);
 484 extern int git_config_int(const char *, const char *);
 485 extern int git_config_bool(const char *, const char *);
 486 extern int git_config_set(const char *, const char *);
 487 extern int git_config_set_multivar(const char *, const char *, const char *, int);
 488 extern int git_config_rename_section(const char *, const char *);
 489 extern int check_repository_format_version(const char *var, const char *value);
 490
 491 #define MAX_GITNAME (1000)
 492 extern char git_default_email[MAX_GITNAME];
 493 extern char git_default_name[MAX_GITNAME];
 494
 495 extern const char *git_commit_encoding;
 496 extern const char *git_log_output_encoding;
 497
 498 extern int copy_fd(int ifd, int ofd);
 499 extern int read_in_full(int fd, void *buf, size_t count);
 500 extern int write_in_full(int fd, const void *buf, size_t count);
 501 extern void write_or_die(int fd, const void *buf, size_t count);
 502 extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
 503 extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
 504
 505 /* pager.c */
 506 extern void setup_pager(void);
 507 extern int pager_in_use;
 508 extern int pager_use_color;
 509
 510 /* base85 */
 511 int decode_85(char *dst, const char *line, int linelen);
 512 void encode_85(char *buf, const unsigned char *data, int bytes);
 513
 514 /* alloc.c */
 515 extern void *alloc_blob_node(void);
 516 extern void *alloc_tree_node(void);
 517 extern void *alloc_commit_node(void);
 518 extern void *alloc_tag_node(void);
 519 extern void *alloc_object_node(void);
 520 extern void alloc_report(void);
 521
 522 /* trace.c */
 523 extern int nfasprintf(char **str, const char *fmt, ...);
 524 extern int nfvasprintf(char **str, const char *fmt, va_list va);
 525 extern void trace_printf(const char *format, ...);
 526 extern void trace_argv_printf(const char **argv, int count, const char *format, ...);
 527
 528 /* convert.c */
 529 extern char *convert_to_git(const char *path, const char *src, unsigned long *sizep);
 530 extern char *convert_to_working_tree(const char *path, const char *src, unsigned long *sizep);
 531
 532 /* match-trees.c */
 533 void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
 534
 535 #endif /* CACHE_H */