Andrew's git - gitweb.git/blob

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