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