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