Andrew's git / gitweb.git / cache.h
?
cache.hon commit ls-files --others --directory: give trailing slash (0907fed)
   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#ifdef DT_UNKNOWN
  14#define DTYPE(de)       ((de)->d_type)
  15#else
  16#define DT_UNKNOWN      0
  17#define DT_DIR          1
  18#define DT_REG          2
  19#define DT_LNK          3
  20#define DTYPE(de)       DT_UNKNOWN
  21#endif
  22
  23/*
  24 * Intensive research over the course of many years has shown that
  25 * port 9418 is totally unused by anything else. Or
  26 *
  27 *      Your search - "port 9418" - did not match any documents.
  28 *
  29 * as www.google.com puts it.
  30 *
  31 * This port has been properly assigned for git use by IANA:
  32 * git (Assigned-9418) [I06-050728-0001].
  33 *
  34 *      git  9418/tcp   git pack transfer service
  35 *      git  9418/udp   git pack transfer service
  36 *
  37 * with Linus Torvalds <torvalds@osdl.org> as the point of
  38 * contact. September 2005.
  39 *
  40 * See http://www.iana.org/assignments/port-numbers
  41 */
  42#define DEFAULT_GIT_PORT 9418
  43
  44/*
  45 * Basic data structures for the directory cache
  46 */
  47
  48#define CACHE_SIGNATURE 0x44495243      /* "DIRC" */
  49struct cache_header {
  50        unsigned int hdr_signature;
  51        unsigned int hdr_version;
  52        unsigned int hdr_entries;
  53};
  54
  55/*
  56 * The "cache_time" is just the low 32 bits of the
  57 * time. It doesn't matter if it overflows - we only
  58 * check it for equality in the 32 bits we save.
  59 */
  60struct cache_time {
  61        unsigned int sec;
  62        unsigned int nsec;
  63};
  64
  65/*
  66 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
  67 * Again - this is just a (very strong in practice) heuristic that
  68 * the inode hasn't changed.
  69 *
  70 * We save the fields in big-endian order to allow using the
  71 * index file over NFS transparently.
  72 */
  73struct cache_entry {
  74        struct cache_time ce_ctime;
  75        struct cache_time ce_mtime;
  76        unsigned int ce_dev;
  77        unsigned int ce_ino;
  78        unsigned int ce_mode;
  79        unsigned int ce_uid;
  80        unsigned int ce_gid;
  81        unsigned int ce_size;
  82        unsigned char sha1[20];
  83        unsigned short ce_flags;
  84        char name[0];
  85};
  86
  87#define CE_NAMEMASK  (0x0fff)
  88#define CE_STAGEMASK (0x3000)
  89#define CE_UPDATE    (0x4000)
  90#define CE_STAGESHIFT 12
  91
  92#define create_ce_flags(len, stage) htons((len) | ((stage) << CE_STAGESHIFT))
  93#define ce_namelen(ce) (CE_NAMEMASK & ntohs((ce)->ce_flags))
  94#define ce_size(ce) cache_entry_size(ce_namelen(ce))
  95#define ce_stage(ce) ((CE_STAGEMASK & ntohs((ce)->ce_flags)) >> CE_STAGESHIFT)
  96
  97#define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
  98static inline unsigned int create_ce_mode(unsigned int mode)
  99{
 100        if (S_ISLNK(mode))
 101                return htonl(S_IFLNK);
 102        return htonl(S_IFREG | ce_permissions(mode));
 103}
 104
 105#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
 106
 107extern struct cache_entry **active_cache;
 108extern unsigned int active_nr, active_alloc, active_cache_changed;
 109
 110#define GIT_DIR_ENVIRONMENT "GIT_DIR"
 111#define DEFAULT_GIT_DIR_ENVIRONMENT ".git"
 112#define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
 113#define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
 114#define GRAFT_ENVIRONMENT "GIT_GRAFT_FILE"
 115
 116extern char *get_git_dir(void);
 117extern char *get_object_directory(void);
 118extern char *get_refs_directory(void);
 119extern char *get_index_file(void);
 120extern char *get_graft_file(void);
 121
 122#define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
 123
 124extern const char **get_pathspec(const char *prefix, const char **pathspec);
 125extern const char *setup_git_directory_gently(int *);
 126extern const char *setup_git_directory(void);
 127extern const char *prefix_path(const char *prefix, int len, const char *path);
 128extern const char *prefix_filename(const char *prefix, int len, const char *path);
 129
 130#define alloc_nr(x) (((x)+16)*3/2)
 131
 132/* Initialize and use the cache information */
 133extern int read_cache(void);
 134extern int write_cache(int newfd, struct cache_entry **cache, int entries);
 135extern int cache_name_pos(const char *name, int namelen);
 136#define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
 137#define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
 138#define ADD_CACHE_SKIP_DFCHECK 4        /* Ok to skip DF conflict checks */
 139extern int add_cache_entry(struct cache_entry *ce, int option);
 140extern int remove_cache_entry_at(int pos);
 141extern int remove_file_from_cache(const char *path);
 142extern int ce_same_name(struct cache_entry *a, struct cache_entry *b);
 143extern int ce_match_stat(struct cache_entry *ce, struct stat *st);
 144extern int ce_modified(struct cache_entry *ce, struct stat *st);
 145extern int ce_path_match(const struct cache_entry *ce, const char **pathspec);
 146extern int index_fd(unsigned char *sha1, int fd, struct stat *st, int write_object, const char *type);
 147extern int index_pipe(unsigned char *sha1, int fd, const char *type, int write_object);
 148extern int index_path(unsigned char *sha1, const char *path, struct stat *st, int write_object);
 149extern void fill_stat_cache_info(struct cache_entry *ce, struct stat *st);
 150
 151struct cache_file {
 152        struct cache_file *next;
 153        char lockfile[PATH_MAX];
 154};
 155extern int hold_index_file_for_update(struct cache_file *, const char *path);
 156extern int commit_index_file(struct cache_file *);
 157extern void rollback_index_file(struct cache_file *);
 158
 159extern int trust_executable_bit;
 160extern int only_use_symrefs;
 161extern int diff_rename_limit_default;
 162extern int shared_repository;
 163
 164#define GIT_REPO_VERSION 0
 165extern int repository_format_version;
 166extern int check_repository_format(void);
 167
 168#define MTIME_CHANGED   0x0001
 169#define CTIME_CHANGED   0x0002
 170#define OWNER_CHANGED   0x0004
 171#define MODE_CHANGED    0x0008
 172#define INODE_CHANGED   0x0010
 173#define DATA_CHANGED    0x0020
 174#define TYPE_CHANGED    0x0040
 175
 176/* Return a statically allocated filename matching the sha1 signature */
 177extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 178extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
 179extern char *sha1_file_name(const unsigned char *sha1);
 180extern char *sha1_pack_name(const unsigned char *sha1);
 181extern char *sha1_pack_index_name(const unsigned char *sha1);
 182extern const char *find_unique_abbrev(const unsigned char *sha1, int);
 183extern const unsigned char null_sha1[20];
 184
 185int git_mkstemp(char *path, size_t n, const char *template);
 186
 187int adjust_shared_perm(const char *path);
 188int safe_create_leading_directories(char *path);
 189char *safe_strncpy(char *, const char *, size_t);
 190char *enter_repo(char *path, int strict);
 191
 192/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
 193extern int unpack_sha1_header(z_stream *stream, void *map, unsigned long mapsize, void *buffer, unsigned long size);
 194extern int parse_sha1_header(char *hdr, char *type, unsigned long *sizep);
 195extern int sha1_object_info(const unsigned char *, char *, unsigned long *);
 196extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
 197extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
 198extern int write_sha1_file(void *buf, unsigned long len, const char *type, unsigned char *return_sha1);
 199extern char *write_sha1_file_prepare(void *buf,
 200                                     unsigned long len,
 201                                     const char *type,
 202                                     unsigned char *sha1,
 203                                     unsigned char *hdr,
 204                                     int *hdrlen);
 205
 206extern int check_sha1_signature(const unsigned char *sha1, void *buf, unsigned long size, const char *type);
 207
 208/* Read a tree into the cache */
 209extern int read_tree(void *buffer, unsigned long size, int stage, const char **paths);
 210
 211extern int write_sha1_from_fd(const unsigned char *sha1, int fd, char *buffer,
 212                              size_t bufsize, size_t *bufposn);
 213extern int write_sha1_to_fd(int fd, const unsigned char *sha1);
 214extern int move_temp_to_file(const char *tmpfile, char *filename);
 215
 216extern int has_sha1_pack(const unsigned char *sha1);
 217extern int has_sha1_file(const unsigned char *sha1);
 218
 219extern int has_pack_file(const unsigned char *sha1);
 220extern int has_pack_index(const unsigned char *sha1);
 221
 222/* Convert to/from hex/sha1 representation */
 223extern int get_sha1(const char *str, unsigned char *sha1);
 224extern int get_sha1_hex(const char *hex, unsigned char *sha1);
 225extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
 226extern int read_ref(const char *filename, unsigned char *sha1);
 227extern const char *resolve_ref(const char *path, unsigned char *sha1, int);
 228extern int create_symref(const char *git_HEAD, const char *refs_heads_master);
 229extern int validate_symref(const char *git_HEAD);
 230
 231extern int base_name_compare(const char *name1, int len1, int mode1, const char *name2, int len2, int mode2);
 232extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
 233
 234extern void *read_object_with_reference(const unsigned char *sha1,
 235                                        const char *required_type,
 236                                        unsigned long *size,
 237                                        unsigned char *sha1_ret);
 238
 239const char *show_date(unsigned long time, int timezone);
 240int parse_date(const char *date, char *buf, int bufsize);
 241void datestamp(char *buf, int bufsize);
 242unsigned long approxidate(const char *);
 243
 244extern int setup_ident(void);
 245extern const char *git_author_info(void);
 246extern const char *git_committer_info(void);
 247
 248struct checkout {
 249        const char *base_dir;
 250        int base_dir_len;
 251        unsigned force:1,
 252                 quiet:1,
 253                 not_new:1,
 254                 refresh_cache:1;
 255};
 256
 257extern int checkout_entry(struct cache_entry *ce, struct checkout *state);
 258
 259extern struct alternate_object_database {
 260        struct alternate_object_database *next;
 261        char *name;
 262        char base[0]; /* more */
 263} *alt_odb_list;
 264extern void prepare_alt_odb(void);
 265
 266extern struct packed_git {
 267        struct packed_git *next;
 268        unsigned long index_size;
 269        unsigned long pack_size;
 270        unsigned int *index_base;
 271        void *pack_base;
 272        unsigned int pack_last_used;
 273        unsigned int pack_use_cnt;
 274        int pack_local;
 275        unsigned char sha1[20];
 276        char pack_name[0]; /* something like ".git/objects/pack/xxxxx.pack" */
 277} *packed_git;
 278
 279struct pack_entry {
 280        unsigned int offset;
 281        unsigned char sha1[20];
 282        struct packed_git *p;
 283};
 284
 285struct ref {
 286        struct ref *next;
 287        unsigned char old_sha1[20];
 288        unsigned char new_sha1[20];
 289        unsigned char force;
 290        struct ref *peer_ref; /* when renaming */
 291        char name[0];
 292};
 293
 294extern int git_connect(int fd[2], char *url, const char *prog);
 295extern int finish_connect(pid_t pid);
 296extern int path_match(const char *path, int nr, char **match);
 297extern int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
 298                      int nr_refspec, char **refspec, int all);
 299extern int get_ack(int fd, unsigned char *result_sha1);
 300extern struct ref **get_remote_heads(int in, struct ref **list, int nr_match, char **match, int ignore_funny);
 301extern int server_supports(const char *feature);
 302
 303extern struct packed_git *parse_pack_index(unsigned char *sha1);
 304extern struct packed_git *parse_pack_index_file(const unsigned char *sha1,
 305                                                char *idx_path);
 306
 307extern void prepare_packed_git(void);
 308extern void install_packed_git(struct packed_git *pack);
 309
 310extern struct packed_git *find_sha1_pack(const unsigned char *sha1, 
 311                                         struct packed_git *packs);
 312
 313extern int use_packed_git(struct packed_git *);
 314extern void unuse_packed_git(struct packed_git *);
 315extern struct packed_git *add_packed_git(char *, int, int);
 316extern int num_packed_objects(const struct packed_git *p);
 317extern int nth_packed_object_sha1(const struct packed_git *, int, unsigned char*);
 318extern int find_pack_entry_one(const unsigned char *, struct pack_entry *, struct packed_git *);
 319extern void *unpack_entry_gently(struct pack_entry *, char *, unsigned long *);
 320extern void packed_object_info_detail(struct pack_entry *, char *, unsigned long *, unsigned long *, int *, unsigned char *);
 321
 322/* Dumb servers support */
 323extern int update_server_info(int);
 324
 325typedef int (*config_fn_t)(const char *, const char *);
 326extern int git_default_config(const char *, const char *);
 327extern int git_config_from_file(config_fn_t fn, const char *);
 328extern int git_config(config_fn_t fn);
 329extern int git_config_int(const char *, const char *);
 330extern int git_config_bool(const char *, const char *);
 331extern int git_config_set(const char *, const char *);
 332extern int git_config_set_multivar(const char *, const char *, const char *, int);
 333extern int check_repository_format_version(const char *var, const char *value);
 334
 335#define MAX_GITNAME (1000)
 336extern char git_default_email[MAX_GITNAME];
 337extern char git_default_name[MAX_GITNAME];
 338
 339#define MAX_ENCODING_LENGTH 64
 340extern char git_commit_encoding[MAX_ENCODING_LENGTH];
 341
 342extern int copy_fd(int ifd, int ofd);
 343
 344/* Finish off pack transfer receiving end */
 345extern int receive_unpack_pack(int fd[2], const char *me, int quiet);
 346extern int receive_keep_pack(int fd[2], const char *me);
 347
 348#endif /* CACHE_H */