cache.h

   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 <sys/mman.h>
  14 #include <sys/param.h>
  15 #include <netinet/in.h>
  16
  17 #include SHA1_HEADER
  18 #include <zlib.h>
  19
  20 #if ZLIB_VERNUM < 0x1200
  21 #define deflateBound(c,s)  ((s) + (((s) + 7) >> 3) + (((s) + 63) >> 6) + 11)
  22 #endif
  23
  24 #ifdef DT_UNKNOWN
  25 #define DTYPE(de)       ((de)->d_type)
  26 #else
  27 #define DT_UNKNOWN      0
  28 #define DT_DIR          1
  29 #define DT_REG          2
  30 #define DTYPE(de)       DT_UNKNOWN
  31 #endif
  32
  33 /*
  34  * Environment variables transition.
  35  * We accept older names for now but warn.
  36  */
  37 extern char *gitenv_bc(const char *);
  38 #define gitenv(e) (getenv(e) ? : gitenv_bc(e))
  39
  40 /*
  41  * Basic data structures for the directory cache
  42  *
  43  * NOTE NOTE NOTE! This is all in the native CPU byte format. It's
  44  * not even trying to be portable. It's trying to be efficient. It's
  45  * just a cache, after all.
  46  */
  47
  48 #define CACHE_SIGNATURE 0x44495243      /* "DIRC" */
  49 struct 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  */
  60 struct 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  */
  73 struct 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_STAGESHIFT 12
  90
  91 #define create_ce_flags(len, stage) htons((len) | ((stage) << CE_STAGESHIFT))
  92 #define ce_namelen(ce) (CE_NAMEMASK & ntohs((ce)->ce_flags))
  93 #define ce_size(ce) cache_entry_size(ce_namelen(ce))
  94 #define ce_stage(ce) ((CE_STAGEMASK & ntohs((ce)->ce_flags)) >> CE_STAGESHIFT)
  95
  96 #define ce_permissions(mode) (((mode) & 0100) ? 0755 : 0644)
  97 static inline unsigned int create_ce_mode(unsigned int mode)
  98 {
  99         if (S_ISLNK(mode))
 100                 return htonl(S_IFLNK);
 101         return htonl(S_IFREG | ce_permissions(mode));
 102 }
 103
 104 #define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
 105
 106 struct cache_entry **active_cache;
 107 unsigned int active_nr, active_alloc, active_cache_changed;
 108
 109 #define DB_ENVIRONMENT "GIT_OBJECT_DIRECTORY"
 110 #define DEFAULT_DB_ENVIRONMENT ".git/objects"
 111 #define ALTERNATE_DB_ENVIRONMENT "GIT_ALTERNATE_OBJECT_DIRECTORIES"
 112
 113 #define get_object_directory() (gitenv(DB_ENVIRONMENT) ? : DEFAULT_DB_ENVIRONMENT)
 114
 115 #define INDEX_ENVIRONMENT "GIT_INDEX_FILE"
 116 #define DEFAULT_INDEX_ENVIRONMENT ".git/index"
 117
 118 #define get_index_file() (gitenv(INDEX_ENVIRONMENT) ? : DEFAULT_INDEX_ENVIRONMENT)
 119
 120 #define alloc_nr(x) (((x)+16)*3/2)
 121
 122 /* Initialize and use the cache information */
 123 extern int read_cache(void);
 124 extern int write_cache(int newfd, struct cache_entry **cache, int entries);
 125 extern int cache_name_pos(const char *name, int namelen);
 126 #define ADD_CACHE_OK_TO_ADD 1           /* Ok to add */
 127 #define ADD_CACHE_OK_TO_REPLACE 2       /* Ok to replace file/directory */
 128 extern int add_cache_entry(struct cache_entry *ce, int option);
 129 extern int remove_entry_at(int pos);
 130 extern int remove_file_from_cache(char *path);
 131 extern int same_name(struct cache_entry *a, struct cache_entry *b);
 132 extern int cache_match_stat(struct cache_entry *ce, struct stat *st);
 133 extern int index_fd(unsigned char *sha1, int fd, struct stat *st);
 134
 135 #define MTIME_CHANGED   0x0001
 136 #define CTIME_CHANGED   0x0002
 137 #define OWNER_CHANGED   0x0004
 138 #define MODE_CHANGED    0x0008
 139 #define INODE_CHANGED   0x0010
 140 #define DATA_CHANGED    0x0020
 141 #define TYPE_CHANGED    0x0040
 142
 143 /* Return a statically allocated filename matching the sha1 signature */
 144 extern char *sha1_file_name(const unsigned char *sha1);
 145
 146 /* Read and unpack a sha1 file into memory, write memory to a sha1 file */
 147 extern void * map_sha1_file(const unsigned char *sha1, unsigned long *size);
 148 extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
 149 extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
 150 extern int write_sha1_file(char *buf, unsigned long len, const char *type, unsigned char *return_sha1);
 151
 152 extern int check_sha1_signature(unsigned char *sha1, void *buf, unsigned long size, const char *type);
 153
 154 /* Read a tree into the cache */
 155 extern int read_tree(void *buffer, unsigned long size, int stage);
 156
 157 extern int write_sha1_from_fd(const unsigned char *sha1, int fd);
 158
 159 extern int has_sha1_file(const unsigned char *sha1);
 160
 161 /* Convert to/from hex/sha1 representation */
 162 extern int get_sha1(const char *str, unsigned char *sha1);
 163 extern int get_sha1_hex(const char *hex, unsigned char *sha1);
 164 extern char *sha1_to_hex(const unsigned char *sha1);    /* static buffer result! */
 165
 166 /* General helper functions */
 167 extern void usage(const char *err);
 168 extern void die(const char *err, ...);
 169 extern int error(const char *err, ...);
 170
 171 extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
 172
 173 extern void *read_object_with_reference(const unsigned char *sha1,
 174                                         const unsigned char *required_type,
 175                                         unsigned long *size,
 176                                         unsigned char *sha1_ret);
 177
 178 const char *show_date(unsigned long time, int timezone);
 179 void parse_date(char *date, char *buf, int bufsize);
 180 void datestamp(char *buf, int bufsize);
 181
 182 static inline void *xmalloc(int size)
 183 {
 184         void *ret = malloc(size);
 185         if (!ret)
 186                 die("Out of memory, malloc failed");
 187         return ret;
 188 }
 189
 190 static inline void *xrealloc(void *ptr, int size)
 191 {
 192         void *ret = realloc(ptr, size);
 193         if (!ret)
 194                 die("Out of memory, realloc failed");
 195         return ret;
 196 }
 197
 198 #endif /* CACHE_H */