Andrew's git / gitweb.git / cache.h
?
cache.hon commit Save errno in handle_alias() (47e5c0c)
   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}
 109#define canon_mode(mode) \
 110        (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
 111        S_ISLNK(mode) ? S_IFLNK : S_IFDIR)
 112
 113#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
 114
 115extern struct cache_entry **active_cache;
 116extern unsigned int active_nr, active_alloc, active_cache_changed;
 117extern struct cache_tree *active_cache_tree;
 118
 119#define GIT_DIR_ENVIRONMENT "GIT_DIR"
 120#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
 121#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
 122#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
 123#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
 124
 125extern char *get_git_dir(void);
 126extern char *get_object_directory(void);
 127extern char *get_refs_directory(void);
 128extern char *get_index_file(void);
 129extern char *get_graft_file(void);
 130
 131#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
 132
 133extern const char **get_pathspec(const char *prefix, const char **pathspec);
 134extern const char *setup_git_directory_gently(int *);
 135extern const char *setup_git_directory(void);
 136extern const char *prefix_path(const char *prefix, int len, const char *path);
 137extern const char *prefix_filename(const char *prefix, int len, const char *path);
 138extern void verify_filename(const char *prefix, const char *name);
 139extern void verify_non_filename(const char *prefix, const char *name);
 140
 141#define alloc_nr(x) (((x)+16)*3/2)
 142
 143/* Initialize and use the cache information */
 144extern int read_cache(void);
 145extern int write_cache(int newfd, struct cache_entry **cache, int entries);
 146extern int verify_path(const char *path);
 147extern int cache_name_pos(const char *name, int namelen);
 148#define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
 149#define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
 150#define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
 151extern int add_cache_entry(struct cache_entry *ce, int option);
 152extern int remove_cache_entry_at(int pos);
 153extern int remove_file_from_cache(const char *path);
 154extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
 155extern int ce_match_stat(struct cache_entry *ce, struct stat *st, int);
 156extern int ce_modified(struct cache_entry *ce, struct stat *st, int);
 157extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
 158extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, const char *type);
 159extern int read_pipe(int fd, char** return_buf, unsigned long* return_size);
 160extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
 161extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
 162extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
 163
 164#define REFRESH_REALLY          0x0001  /* ignore_valid */
 165#define REFRESH_UNMERGED        0x0002  /* allow unmerged */
 166#define REFRESH_QUIET           0x0004  /* be quiet about it */
 167#define REFRESH_IGNORE_MISSING  0x0008  /* ignore non-existent */
 168extern int refresh_cache(unsigned int flags);
 169
 170struct lock_file {
 171        struct lock_file *next;
 172        char filename[PATH_MAX];
 173};
 174extern int hold_lock_file_for_update(struct lock_file *, const char *path);
 175extern int commit_lock_file(struct lock_file *);
 176extern void rollback_lock_file(struct lock_file *);
 177
 178/* Environment bits from configuration mechanism */
 179extern int trust_executable_bit;
 180extern int assume_unchanged;
 181extern int prefer_symlink_refs;
 182extern int log_all_ref_updates;
 183extern int warn_ambiguous_refs;
 184extern int shared_repository;
 185extern const char *apply_default_whitespace;
 186
 187#define GIT_REPO_VERSION 0
 188extern int repository_format_version;
 189extern int check_repository_format(void);
 190
 191#define MTIME_CHANGED   0x0001
 192#define CTIME_CHANGED   0x0002
 193#define OWNER_CHANGED   0x0004
 194#define MODE_CHANGED    0x0008
 195#define INODE_CHANGED   0x0010
 196#define DATA_CHANGED    0x0020
 197#define TYPE_CHANGED    0x0040
 198
 199/* Return a statically allocated filename matching the sha1 signature */
 200extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 201extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 202extern char *sha1_file_name(const unsigned char *sha1);
 203extern char *sha1_pack_name(const unsigned char *sha1);
 204extern char *sha1_pack_index_name(const unsigned char *sha1);
 205extern const char *find_unique_abbrev(const unsigned char *sha1, int);
 206extern const unsigned char null_sha1[20];
 207
 208int git_mkstemp(char *path, size_t n, const char *template);
 209
 210enum sharedrepo {
 211        PERM_UMASK = 0,
 212        PERM_GROUP,
 213        PERM_EVERYBODY
 214};
 215int git_config_perm(const char *var, const char *value);
 216int adjust_shared_perm(const char *path);
 217int safe_create_leading_directories(char *path);
 218char *enter_repo(char *path, int strict);
 219
 220/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
 221extern int unpack_sha1_header(z_stream *stream, void *map, unsigned long mapsize, void *buffer, unsigned long size);
 222extern int parse_sha1_header(char *hdr, char *type, unsigned long *sizep);
 223extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
 224extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
 225extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
 226extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
 227extern char *write_sha1_file_prepare(void *buf,
 228                                     unsigned long len,
 229                                     const char *type,
 230                                     unsigned char *sha1,
 231                                     unsigned char *hdr,
 232                                     int *hdrlen);
 233
 234extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
 235
 236extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
 237                              size_t bufsize, size_t *bufposn);
 238extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
 239extern int move_temp_to_file(const char *tmpfile, char *filename);
 240
 241extern int has_sha1_pack(const unsigned char *sha1);
 242extern int has_sha1_file(const unsigned char *sha1);
 243
 244extern int has_pack_file(const unsigned char *sha1);
 245extern int has_pack_index(const unsigned char *sha1);
 246
 247/* Convert to/from hex/sha1 representation */
 248#define MINIMUM_ABBREV 4
 249#define DEFAULT_ABBREV 7
 250
 251extern int get_sha1(const char *str, unsigned char *sha1);
 252extern int get_sha1_hex(const char *hex, unsigned char *sha1);
 253extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
 254extern int read_ref(const char *filename, unsigned char *sha1);
 255extern const char *resolve_ref(const char *path, unsigned char *sha1, int);
 256extern int create_symref(const char *git_HEAD, const char *refs_heads_master);
 257extern int validate_symref(const char *git_HEAD);
 258
 259extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
 260extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
 261
 262extern void *read_object_with_reference(const unsigned char *sha1,
 263                                        const char *required_type,
 264                                        unsigned long *size,
 265                                        unsigned char *sha1_ret);
 266
 267const char *show_date(unsigned long time, int timezone);
 268const char *show_rfc2822_date(unsigned long time, int timezone);
 269int parse_date(const char *date, char *buf, int bufsize);
 270void datestamp(char *buf, int bufsize);
 271unsigned long approxidate(const char *);
 272
 273extern int setup_ident(void);
 274extern const char *git_author_info(int);
 275extern const char *git_committer_info(int);
 276
 277struct checkout {
 278        const char *base_dir;
 279        int base_dir_len;
 280        unsigned force:1,
 281                 quiet:1,
 282                 not_new:1,
 283                 refresh_cache:1;
 284};
 285
 286extern int checkout_entry(struct cache_entry *ce, struct checkout *state, char *topath);
 287
 288extern struct alternate_object_database {
 289        struct alternate_object_database *next;
 290        char *name;
 291        char base[FLEX_ARRAY]; /* more */
 292} *alt_odb_list;
 293extern void prepare_alt_odb(void);
 294
 295extern struct packed_git {
 296        struct packed_git *next;
 297        unsigned long index_size;
 298        unsigned long pack_size;
 299        unsigned int *index_base;
 300        void *pack_base;
 301        unsigned int pack_last_used;
 302        unsigned int pack_use_cnt;
 303        int pack_local;
 304        unsigned char sha1[20];
 305        /* something like ".git/objects/pack/xxxxx.pack" */
 306        char pack_name[FLEX_ARRAY]; /* more */
 307} *packed_git;
 308
 309struct pack_entry {
 310        unsigned int offset;
 311        unsigned char sha1[20];
 312        struct packed_git *p;
 313};
 314
 315struct ref {
 316        struct ref *next;
 317        unsigned char old_sha1[20];
 318        unsigned char new_sha1[20];
 319        unsigned char force;
 320        struct ref *peer_ref; /* when renaming */
 321        char name[FLEX_ARRAY]; /* more */
 322};
 323
 324extern int git_connect(int fd[2], char *url, const char *prog);
 325extern int finish_connect(pid_t pid);
 326extern int path_match(const char *path, int nr, char **match);
 327extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
 328                      int nr_refspec, char **refspec, int all);
 329extern int get_ack(int fd, unsigned char *result_sha1);
 330extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, int ignore_funny);
 331extern int server_supports(const char *feature);
 332
 333extern struct packed_git *parse_pack_index(unsigned char *sha1);
 334extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
 335                                                char *idx_path);
 336
 337extern void prepare_packed_git(void);
 338extern void install_packed_git(struct packed_git *pack);
 339
 340extern struct packed_git *find_sha1_pack(const unsigned char *sha1, 
 341                                         struct packed_git *packs);
 342
 343extern int use_packed_git(struct packed_git *);
 344extern void unuse_packed_git(struct packed_git *);
 345extern struct packed_git *add_packed_git(char *, int, int);
 346extern int num_packed_objects(const struct packed_git *p);
 347extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
 348extern int find_pack_entry_one(const unsigned char *, struct pack_entry *, struct packed_git *);
 349extern void *unpack_entry_gently(struct pack_entry *, char *, unsigned long *);
 350extern void packed_object_info_detail(struct pack_entry *, char *, unsigned long *, unsigned long *, unsigned int *, unsigned char *);
 351
 352/* Dumb servers support */
 353extern int update_server_info(int);
 354
 355typedef int (*config_fn_t)(const char *, const char *);
 356extern int git_default_config(const char *, const char *);
 357extern int git_config_from_file(config_fn_t fn, const char *);
 358extern int git_config(config_fn_t fn);
 359extern int git_config_int(const char *, const char *);
 360extern int git_config_bool(const char *, const char *);
 361extern int git_config_set(const char *, const char *);
 362extern int git_config_set_multivar(const char *, const char *, const char *, int);
 363extern int check_repository_format_version(const char *var, const char *value);
 364
 365#define MAX_GITNAME (1000)
 366extern char git_default_email[MAX_GITNAME];
 367extern char git_default_name[MAX_GITNAME];
 368
 369#define MAX_ENCODING_LENGTH 64
 370extern char git_commit_encoding[MAX_ENCODING_LENGTH];
 371
 372extern int copy_fd(int ifd, int ofd);
 373
 374/* Finish off pack transfer receiving end */
 375extern int receive_unpack_pack(int fd[2], const char *me, int quiet, int);
 376extern int receive_keep_pack(int fd[2], const char *me, int quiet, int);
 377
 378/* pager.c */
 379extern void setup_pager(void);
 380
 381/* base85 */
 382int decode_85(char *dst, char *line, int linelen);
 383void encode_85(char *buf, unsigned char *data, int bytes);
 384
 385/* alloc.c */
 386struct blob;
 387struct tree;
 388struct commit;
 389struct tag;
 390extern struct blob *alloc_blob_node(void);
 391extern struct tree *alloc_tree_node(void);
 392extern struct commit *alloc_commit_node(void);
 393extern struct tag *alloc_tag_node(void);
 394extern void alloc_report(void);
 395
 396#endif /* CACHE_H */