Andrew's git - gitweb.git/blob

   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" */
  53struct 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 */
  64struct 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 */
  77struct 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)
 103static 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}
 109static 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
 128extern struct cache_entry **active_cache;
 129extern unsigned int active_nr, active_alloc, active_cache_changed;
 130extern struct cache_tree *active_cache_tree;
 131
 132enum 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#define GITATTRIBUTES_FILE ".gitattributes"
 155#define INFOATTRIBUTES_FILE "info/attributes"
 156#define ATTRIBUTE_MACRO_PREFIX "[attr]"
 157
 158extern int is_bare_repository_cfg;
 159extern int is_bare_repository(void);
 160extern int is_inside_git_dir(void);
 161extern const char *get_git_dir(void);
 162extern char *get_object_directory(void);
 163extern char *get_refs_directory(void);
 164extern char *get_index_file(void);
 165extern char *get_graft_file(void);
 166
 167#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
 168
 169extern const char **get_pathspec(const char *prefix, const char **pathspec);
 170extern const char *setup_git_directory_gently(int *);
 171extern const char *setup_git_directory(void);
 172extern const char *prefix_path(const char *prefix, int len, const char *path);
 173extern const char *prefix_filename(const char *prefix, int len, const char *path);
 174extern void verify_filename(const char *prefix, const char *name);
 175extern void verify_non_filename(const char *prefix, const char *name);
 176
 177#define alloc_nr(x) (((x)+16)*3/2)
 178
 179/* Initialize and use the cache information */
 180extern int read_cache(void);
 181extern int read_cache_from(const char *path);
 182extern int write_cache(int newfd, struct cache_entry **cache, int entries);
 183extern int discard_cache(void);
 184extern int verify_path(const char *path);
 185extern int cache_name_pos(const char *name, int namelen);
 186#define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
 187#define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
 188#define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
 189extern int add_cache_entry(struct cache_entry *ce, int option);
 190extern struct cache_entry *refresh_cache_entry(struct cache_entry *ce, int really);
 191extern int remove_cache_entry_at(int pos);
 192extern int remove_file_from_cache(const char *path);
 193extern int add_file_to_cache(const char *path, int verbose);
 194extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
 195extern int ce_match_stat(struct cache_entry *ce, struct stat *st, int);
 196extern int ce_modified(struct cache_entry *ce, struct stat *st, int);
 197extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
 198extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, enum object_type type, const char *path);
 199extern int read_pipe(int fd, char** return_buf, unsigned long* return_size);
 200extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
 201extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
 202extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
 203
 204#define REFRESH_REALLY          0x0001  /* ignore_valid */
 205#define REFRESH_UNMERGED        0x0002  /* allow unmerged */
 206#define REFRESH_QUIET           0x0004  /* be quiet about it */
 207#define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
 208extern int refresh_cache(unsigned int flags);
 209
 210struct lock_file {
 211        struct lock_file *next;
 212        pid_t owner;
 213        char on_list;
 214        char filename[PATH_MAX];
 215};
 216extern int hold_lock_file_for_update(struct lock_file *, const char *path, int);
 217extern int commit_lock_file(struct lock_file *);
 218
 219extern int hold_locked_index(struct lock_file *, int);
 220extern int commit_locked_index(struct lock_file *);
 221extern void set_alternate_index_output(const char *);
 222
 223extern void rollback_lock_file(struct lock_file *);
 224extern int delete_ref(const char *, unsigned char *sha1);
 225
 226/* Environment bits from configuration mechanism */
 227extern int use_legacy_headers;
 228extern int trust_executable_bit;
 229extern int has_symlinks;
 230extern int assume_unchanged;
 231extern int prefer_symlink_refs;
 232extern int log_all_ref_updates;
 233extern int warn_ambiguous_refs;
 234extern int shared_repository;
 235extern const char *apply_default_whitespace;
 236extern int zlib_compression_level;
 237extern size_t packed_git_window_size;
 238extern size_t packed_git_limit;
 239extern size_t delta_base_cache_limit;
 240extern int auto_crlf;
 241
 242#define GIT_REPO_VERSION 0
 243extern int repository_format_version;
 244extern int check_repository_format(void);
 245
 246#define MTIME_CHANGED   0x0001
 247#define CTIME_CHANGED   0x0002
 248#define OWNER_CHANGED   0x0004
 249#define MODE_CHANGED    0x0008
 250#define INODE_CHANGED   0x0010
 251#define DATA_CHANGED    0x0020
 252#define TYPE_CHANGED    0x0040
 253
 254/* Return a statically allocated filename matching the sha1 signature */
 255extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 256extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 257extern char *sha1_file_name(const unsigned char *sha1);
 258extern char *sha1_pack_name(const unsigned char *sha1);
 259extern char *sha1_pack_index_name(const unsigned char *sha1);
 260extern const char *find_unique_abbrev(const unsigned char *sha1, int);
 261extern const unsigned char null_sha1[20];
 262static inline int is_null_sha1(const unsigned char *sha1)
 263{
 264        return !memcmp(sha1, null_sha1, 20);
 265}
 266static inline int hashcmp(const unsigned char *sha1, const unsigned char *sha2)
 267{
 268        return memcmp(sha1, sha2, 20);
 269}
 270static inline void hashcpy(unsigned char *sha_dst, const unsigned char *sha_src)
 271{
 272        memcpy(sha_dst, sha_src, 20);
 273}
 274static inline void hashclr(unsigned char *hash)
 275{
 276        memset(hash, 0, 20);
 277}
 278
 279int git_mkstemp(char *path, size_t n, const char *template);
 280
 281enum sharedrepo {
 282        PERM_UMASK = 0,
 283        PERM_GROUP,
 284        PERM_EVERYBODY
 285};
 286int git_config_perm(const char *var, const char *value);
 287int adjust_shared_perm(const char *path);
 288int safe_create_leading_directories(char *path);
 289char *enter_repo(char *path, int strict);
 290
 291/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
 292extern int sha1_object_info(const unsigned char *, unsigned long *);
 293extern void * read_sha1_file(const unsigned char *sha1, enum object_type *type, unsigned long *size);
 294extern int hash_sha1_file(const void *buf, unsigned long len, const char *type, unsigned char *sha1);
 295extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
 296extern int pretend_sha1_file(void *, unsigned long, enum object_type, unsigned char *);
 297
 298extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
 299
 300extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
 301                              size_t bufsize, size_t *bufposn);
 302extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
 303extern int move_temp_to_file(const char *tmpfile, const char *filename);
 304
 305extern int has_sha1_pack(const unsigned char *sha1, const char **ignore);
 306extern int has_sha1_file(const unsigned char *sha1);
 307extern void *map_sha1_file(const unsigned char *sha1, unsigned long *);
 308extern int legacy_loose_object(unsigned char *);
 309
 310extern int has_pack_file(const unsigned char *sha1);
 311extern int has_pack_index(const unsigned char *sha1);
 312
 313extern signed char hexval_table[256];
 314static inline unsigned int hexval(unsigned int c)
 315{
 316        return hexval_table[c];
 317}
 318
 319/* Convert to/from hex/sha1 representation */
 320#define MINIMUM_ABBREV 4
 321#define DEFAULT_ABBREV 7
 322
 323extern int get_sha1(const char *str, unsigned char *sha1);
 324extern int get_sha1_hex(const char *hex, unsigned char *sha1);
 325extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
 326extern int read_ref(const char *filename, unsigned char *sha1);
 327extern const char *resolve_ref(const char *path, unsigned char *sha1, int, int *);
 328extern int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref);
 329extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
 330
 331extern int create_symref(const char *ref, const char *refs_heads_master, const char *logmsg);
 332extern int validate_headref(const char *ref);
 333
 334extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
 335extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
 336
 337extern void *read_object_with_reference(const unsigned char *sha1,
 338                                        const char *required_type,
 339                                        unsigned long *size,
 340                                        unsigned char *sha1_ret);
 341
 342enum date_mode { DATE_NORMAL = 0, DATE_RELATIVE, DATE_SHORT };
 343const char *show_date(unsigned long time, int timezone, enum date_mode mode);
 344const char *show_rfc2822_date(unsigned long time, int timezone);
 345int parse_date(const char *date, char *buf, int bufsize);
 346void datestamp(char *buf, int bufsize);
 347unsigned long approxidate(const char *);
 348
 349extern const char *git_author_info(int);
 350extern const char *git_committer_info(int);
 351extern const char *fmt_ident(const char *name, const char *email, const char *date_str, int);
 352
 353struct checkout {
 354        const char *base_dir;
 355        int base_dir_len;
 356        unsigned force:1,
 357                 quiet:1,
 358                 not_new:1,
 359                 refresh_cache:1;
 360};
 361
 362extern int checkout_entry(struct cache_entry *ce, struct checkout *state, char *topath);
 363
 364extern struct alternate_object_database {
 365        struct alternate_object_database *next;
 366        char *name;
 367        char base[FLEX_ARRAY]; /* more */
 368} *alt_odb_list;
 369extern void prepare_alt_odb(void);
 370
 371struct pack_window {
 372        struct pack_window *next;
 373        unsigned char *base;
 374        off_t offset;
 375        size_t len;
 376        unsigned int last_used;
 377        unsigned int inuse_cnt;
 378};
 379
 380extern struct packed_git {
 381        struct packed_git *next;
 382        struct pack_window *windows;
 383        const void *index_data;
 384        off_t index_size;
 385        off_t pack_size;
 386        time_t mtime;
 387        int index_version;
 388        int pack_fd;
 389        int pack_local;
 390        unsigned char sha1[20];
 391        /* something like ".git/objects/pack/xxxxx.pack" */
 392        char pack_name[FLEX_ARRAY]; /* more */
 393} *packed_git;
 394
 395struct pack_entry {
 396        off_t offset;
 397        unsigned char sha1[20];
 398        struct packed_git *p;
 399};
 400
 401struct ref {
 402        struct ref *next;
 403        unsigned char old_sha1[20];
 404        unsigned char new_sha1[20];
 405        unsigned char force;
 406        struct ref *peer_ref; /* when renaming */
 407        char name[FLEX_ARRAY]; /* more */
 408};
 409
 410#define REF_NORMAL      (1u << 0)
 411#define REF_HEADS       (1u << 1)
 412#define REF_TAGS        (1u << 2)
 413
 414extern pid_t git_connect(int fd[2], char *url, const char *prog);
 415extern int finish_connect(pid_t pid);
 416extern int path_match(const char *path, int nr, char **match);
 417extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
 418                      int nr_refspec, char **refspec, int all);
 419extern int get_ack(int fd, unsigned char *result_sha1);
 420extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, unsigned int flags);
 421extern int server_supports(const char *feature);
 422
 423extern struct packed_git *parse_pack_index(unsigned char *sha1);
 424extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
 425                                                const char *idx_path);
 426
 427extern void prepare_packed_git(void);
 428extern void reprepare_packed_git(void);
 429extern void install_packed_git(struct packed_git *pack);
 430
 431extern struct packed_git *find_sha1_pack(const unsigned char *sha1, 
 432                                         struct packed_git *packs);
 433
 434extern void pack_report(void);
 435extern unsigned char* use_pack(struct packed_git *, struct pack_window **, off_t, unsigned int *);
 436extern void unuse_pack(struct pack_window **);
 437extern struct packed_git *add_packed_git(const char *, int, int);
 438extern uint32_t num_packed_objects(const struct packed_git *p);
 439extern const unsigned char *nth_packed_object_sha1(const struct packed_git *, uint32_t);
 440extern off_t find_pack_entry_one(const unsigned char *, struct packed_git *);
 441extern void *unpack_entry(struct packed_git *, off_t, enum object_type *, unsigned long *);
 442extern unsigned long unpack_object_header_gently(const unsigned char *buf, unsigned long len, enum object_type *type, unsigned long *sizep);
 443extern const char *packed_object_info_detail(struct packed_git *, off_t, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
 444
 445/* Dumb servers support */
 446extern int update_server_info(int);
 447
 448typedef int (*config_fn_t)(const char *, const char *);
 449extern int git_default_config(const char *, const char *);
 450extern int git_config_from_file(config_fn_t fn, const char *);
 451extern int git_config(config_fn_t fn);
 452extern int git_config_int(const char *, const char *);
 453extern int git_config_bool(const char *, const char *);
 454extern int git_config_set(const char *, const char *);
 455extern int git_config_set_multivar(const char *, const char *, const char *, int);
 456extern int git_config_rename_section(const char *, const char *);
 457extern int check_repository_format_version(const char *var, const char *value);
 458
 459#define MAX_GITNAME (1000)
 460extern char git_default_email[MAX_GITNAME];
 461extern char git_default_name[MAX_GITNAME];
 462
 463extern const char *git_commit_encoding;
 464extern const char *git_log_output_encoding;
 465
 466extern int copy_fd(int ifd, int ofd);
 467extern int read_in_full(int fd, void *buf, size_t count);
 468extern int write_in_full(int fd, const void *buf, size_t count);
 469extern void write_or_die(int fd, const void *buf, size_t count);
 470extern int write_or_whine(int fd, const void *buf, size_t count, const char *msg);
 471extern int write_or_whine_pipe(int fd, const void *buf, size_t count, const char *msg);
 472
 473/* pager.c */
 474extern void setup_pager(void);
 475extern int pager_in_use;
 476extern int pager_use_color;
 477
 478/* base85 */
 479int decode_85(char *dst, const char *line, int linelen);
 480void encode_85(char *buf, const unsigned char *data, int bytes);
 481
 482/* alloc.c */
 483struct blob;
 484struct tree;
 485struct commit;
 486struct tag;
 487extern struct blob *alloc_blob_node(void);
 488extern struct tree *alloc_tree_node(void);
 489extern struct commit *alloc_commit_node(void);
 490extern struct tag *alloc_tag_node(void);
 491extern void alloc_report(void);
 492
 493/* trace.c */
 494extern int nfasprintf(char **str, const char *fmt, ...);
 495extern int nfvasprintf(char **str, const char *fmt, va_list va);
 496extern void trace_printf(const char *format, ...);
 497extern void trace_argv_printf(const char **argv, int count, const char *format, ...);
 498
 499/* convert.c */
 500extern char *convert_to_git(const char *path, const char *src, unsigned long *sizep);
 501extern char *convert_to_working_tree(const char *path, const char *src, unsigned long *sizep);
 502
 503/* match-trees.c */
 504void shift_tree(const unsigned char *, const unsigned char *, unsigned char *, int);
 505
 506#endif /* CACHE_H */