blob: 07598d469a15db2c10d36e627c0e77dea065b8ef [file] [log] [blame]
Linus Torvaldse83c5162005-04-07 15:13:13 -07001#ifndef CACHE_H
2#define CACHE_H
3
4#include <stdio.h>
5#include <sys/stat.h>
6#include <fcntl.h>
7#include <stddef.h>
8#include <stdlib.h>
9#include <stdarg.h>
Linus Torvaldsbf0c6e82005-04-08 09:16:38 -070010#include <string.h>
Linus Torvaldse83c5162005-04-07 15:13:13 -070011#include <errno.h>
12#include <sys/mman.h>
13
14#include <openssl/sha.h>
15#include <zlib.h>
16
17/*
18 * Basic data structures for the directory cache
19 *
20 * NOTE NOTE NOTE! This is all in the native CPU byte format. It's
21 * not even trying to be portable. It's trying to be efficient. It's
22 * just a cache, after all.
23 */
24
25#define CACHE_SIGNATURE 0x44495243 /* "DIRC" */
26struct cache_header {
27 unsigned int signature;
28 unsigned int version;
29 unsigned int entries;
30 unsigned char sha1[20];
31};
32
33/*
34 * The "cache_time" is just the low 32 bits of the
35 * time. It doesn't matter if it overflows - we only
36 * check it for equality in the 32 bits we save.
37 */
38struct cache_time {
39 unsigned int sec;
40 unsigned int nsec;
41};
42
43/*
44 * dev/ino/uid/gid/size are also just tracked to the low 32 bits
45 * Again - this is just a (very strong in practice) heuristic that
46 * the inode hasn't changed.
47 */
48struct cache_entry {
49 struct cache_time ctime;
50 struct cache_time mtime;
51 unsigned int st_dev;
52 unsigned int st_ino;
53 unsigned int st_mode;
54 unsigned int st_uid;
55 unsigned int st_gid;
56 unsigned int st_size;
57 unsigned char sha1[20];
58 unsigned short namelen;
Linus Torvalds59c1e242005-04-09 00:25:22 -070059 char name[0];
Linus Torvaldse83c5162005-04-07 15:13:13 -070060};
61
62const char *sha1_file_directory;
63struct cache_entry **active_cache;
64unsigned int active_nr, active_alloc;
65
66#define DB_ENVIRONMENT "SHA1_FILE_DIRECTORY"
Linus Torvalds4bb04f22005-04-11 15:47:57 -070067#define DEFAULT_DB_ENVIRONMENT ".git/objects"
Linus Torvaldse83c5162005-04-07 15:13:13 -070068
69#define cache_entry_size(len) ((offsetof(struct cache_entry,name) + (len) + 8) & ~7)
70#define ce_size(ce) cache_entry_size((ce)->namelen)
71
72#define alloc_nr(x) (((x)+16)*3/2)
73
Linus Torvalds734aab72005-04-09 09:48:20 -070074/* Initialize and use the cache information */
Linus Torvaldse83c5162005-04-07 15:13:13 -070075extern int read_cache(void);
Linus Torvalds197ee8c2005-04-09 12:09:27 -070076extern int write_cache(int newfd, struct cache_entry **cache, int entries);
Linus Torvaldseb38c222005-04-09 09:26:55 -070077extern int cache_name_pos(const char *name, int namelen);
Linus Torvalds121481a2005-04-10 11:32:54 -070078extern int add_cache_entry(struct cache_entry *ce, int ok_to_add);
Linus Torvalds197ee8c2005-04-09 12:09:27 -070079extern int remove_file_from_cache(char *path);
Linus Torvalds734aab72005-04-09 09:48:20 -070080extern int cache_match_stat(struct cache_entry *ce, struct stat *st);
81
82#define MTIME_CHANGED 0x0001
83#define CTIME_CHANGED 0x0002
84#define OWNER_CHANGED 0x0004
85#define MODE_CHANGED 0x0008
86#define INODE_CHANGED 0x0010
87#define DATA_CHANGED 0x0020
Linus Torvaldse83c5162005-04-07 15:13:13 -070088
89/* Return a statically allocated filename matching the sha1 signature */
Linus Torvalds73134b62005-04-10 14:03:58 -070090extern char *sha1_file_name(const unsigned char *sha1);
Linus Torvaldse83c5162005-04-07 15:13:13 -070091
92/* Write a memory buffer out to the sha file */
Linus Torvalds73134b62005-04-10 14:03:58 -070093extern int write_sha1_buffer(const unsigned char *sha1, void *buf, unsigned int size);
Linus Torvaldse83c5162005-04-07 15:13:13 -070094
95/* Read and unpack a sha1 file into memory, write memory to a sha1 file */
Linus Torvalds73134b62005-04-10 14:03:58 -070096extern void * map_sha1_file(const unsigned char *sha1, unsigned long *size);
Linus Torvalds2ade9342005-04-08 15:01:15 -070097extern void * unpack_sha1_file(void *map, unsigned long mapsize, char *type, unsigned long *size);
Linus Torvalds73134b62005-04-10 14:03:58 -070098extern void * read_sha1_file(const unsigned char *sha1, char *type, unsigned long *size);
Linus Torvaldsd6d3f9d2005-04-09 17:09:34 -070099extern int write_sha1_file(char *buf, unsigned len, unsigned char *return_sha1);
Linus Torvalds24778e32005-04-08 14:42:29 -0700100extern int check_sha1_signature(unsigned char *sha1, void *buf, unsigned long size);
Linus Torvaldse83c5162005-04-07 15:13:13 -0700101
102/* Convert to/from hex/sha1 representation */
Linus Torvalds197ee8c2005-04-09 12:09:27 -0700103extern int get_sha1_hex(const char *hex, unsigned char *sha1);
104extern char *sha1_to_hex(const unsigned char *sha1); /* static buffer result! */
Linus Torvaldse83c5162005-04-07 15:13:13 -0700105
106/* General helper functions */
Linus Torvalds121481a2005-04-10 11:32:54 -0700107extern void usage(const char *err, ...);
Linus Torvalds79517a02005-04-09 12:59:11 -0700108extern int cache_name_compare(const char *name1, int len1, const char *name2, int len2);
Linus Torvaldse83c5162005-04-07 15:13:13 -0700109
110#endif /* CACHE_H */