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