summaryrefslogtreecommitdiffabout
Unidiff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--cache.c33
1 files changed, 24 insertions, 9 deletions
diff --git a/cache.c b/cache.c
index add647e..6847202 100644
--- a/cache.c
+++ b/cache.c
@@ -1,308 +1,323 @@
1/* cache.c: cache management 1/* cache.c: cache management
2 * 2 *
3 * Copyright (C) 2006 Lars Hjemli 3 * Copyright (C) 2006 Lars Hjemli
4 * 4 *
5 * Licensed under GNU General Public License v2 5 * Licensed under GNU General Public License v2
6 * (see COPYING for full license text) 6 * (see COPYING for full license text)
7 * 7 *
8 * 8 *
9 * The cache is just a directory structure where each file is a cache slot, 9 * The cache is just a directory structure where each file is a cache slot,
10 * and each filename is based on the hash of some key (e.g. the cgit url). 10 * and each filename is based on the hash of some key (e.g. the cgit url).
11 * Each file contains the full key followed by the cached content for that 11 * Each file contains the full key followed by the cached content for that
12 * key. 12 * key.
13 * 13 *
14 */ 14 */
15 15
16#include "cgit.h" 16#include "cgit.h"
17#include "cache.h" 17#include "cache.h"
18 18
19#define CACHE_BUFSIZE (1024 * 4) 19#define CACHE_BUFSIZE (1024 * 4)
20 20
21struct cache_slot { 21struct cache_slot {
22 const char *key; 22 const char *key;
23 int keylen; 23 int keylen;
24 int ttl; 24 int ttl;
25 cache_fill_fn fn; 25 cache_fill_fn fn;
26 void *cbdata; 26 void *cbdata;
27 int cache_fd; 27 int cache_fd;
28 int lock_fd; 28 int lock_fd;
29 const char *cache_name; 29 const char *cache_name;
30 const char *lock_name; 30 const char *lock_name;
31 int match; 31 int match;
32 struct stat cache_st; 32 struct stat cache_st;
33 struct stat lock_st; 33 struct stat lock_st;
34 int bufsize; 34 int bufsize;
35 char buf[CACHE_BUFSIZE]; 35 char buf[CACHE_BUFSIZE];
36}; 36};
37 37
38/* Open an existing cache slot and fill the cache buffer with 38/* Open an existing cache slot and fill the cache buffer with
39 * (part of) the content of the cache file. Return 0 on success 39 * (part of) the content of the cache file. Return 0 on success
40 * and errno otherwise. 40 * and errno otherwise.
41 */ 41 */
42static int open_slot(struct cache_slot *slot) 42static int open_slot(struct cache_slot *slot)
43{ 43{
44 char *bufz; 44 char *bufz;
45 int bufkeylen = -1; 45 int bufkeylen = -1;
46 46
47 slot->cache_fd = open(slot->cache_name, O_RDONLY); 47 slot->cache_fd = open(slot->cache_name, O_RDONLY);
48 if (slot->cache_fd == -1) 48 if (slot->cache_fd == -1)
49 return errno; 49 return errno;
50 50
51 if (fstat(slot->cache_fd, &slot->cache_st)) 51 if (fstat(slot->cache_fd, &slot->cache_st))
52 return errno; 52 return errno;
53 53
54 slot->bufsize = read(slot->cache_fd, slot->buf, sizeof(slot->buf)); 54 slot->bufsize = read(slot->cache_fd, slot->buf, sizeof(slot->buf));
55 if (slot->bufsize < 0) 55 if (slot->bufsize < 0)
56 return errno; 56 return errno;
57 57
58 bufz = memchr(slot->buf, 0, slot->bufsize); 58 bufz = memchr(slot->buf, 0, slot->bufsize);
59 if (bufz) 59 if (bufz)
60 bufkeylen = bufz - slot->buf; 60 bufkeylen = bufz - slot->buf;
61 61
62 slot->match = bufkeylen == slot->keylen && 62 slot->match = bufkeylen == slot->keylen &&
63 !memcmp(slot->key, slot->buf, bufkeylen + 1); 63 !memcmp(slot->key, slot->buf, bufkeylen + 1);
64 64
65 return 0; 65 return 0;
66} 66}
67 67
68/* Close the active cache slot */ 68/* Close the active cache slot */
69static void close_slot(struct cache_slot *slot) 69static int close_slot(struct cache_slot *slot)
70{ 70{
71 int err = 0;
71 if (slot->cache_fd > 0) { 72 if (slot->cache_fd > 0) {
72 close(slot->cache_fd); 73 if (close(slot->cache_fd))
73 slot->cache_fd = -1; 74 err = errno;
75 else
76 slot->cache_fd = -1;
74 } 77 }
78 return err;
75} 79}
76 80
77/* Print the content of the active cache slot (but skip the key). */ 81/* Print the content of the active cache slot (but skip the key). */
78static int print_slot(struct cache_slot *slot) 82static int print_slot(struct cache_slot *slot)
79{ 83{
80 ssize_t i, j = 0; 84 ssize_t i, j = 0;
81 85
82 i = lseek(slot->cache_fd, slot->keylen + 1, SEEK_SET); 86 i = lseek(slot->cache_fd, slot->keylen + 1, SEEK_SET);
83 if (i != slot->keylen + 1) 87 if (i != slot->keylen + 1)
84 return errno; 88 return errno;
85 89
86 while((i=read(slot->cache_fd, slot->buf, sizeof(slot->buf))) > 0) 90 while((i=read(slot->cache_fd, slot->buf, sizeof(slot->buf))) > 0)
87 j = write(STDOUT_FILENO, slot->buf, i); 91 j = write(STDOUT_FILENO, slot->buf, i);
88 92
89 if (j < 0) 93 if (j < 0)
90 return errno; 94 return errno;
91 else 95 else
92 return 0; 96 return 0;
93} 97}
94 98
95/* Check if the slot has expired */ 99/* Check if the slot has expired */
96static int is_expired(struct cache_slot *slot) 100static int is_expired(struct cache_slot *slot)
97{ 101{
98 if (slot->ttl < 0) 102 if (slot->ttl < 0)
99 return 0; 103 return 0;
100 else 104 else
101 return slot->cache_st.st_mtime + slot->ttl*60 < time(NULL); 105 return slot->cache_st.st_mtime + slot->ttl*60 < time(NULL);
102} 106}
103 107
104/* Check if the slot has been modified since we opened it. 108/* Check if the slot has been modified since we opened it.
105 * NB: If stat() fails, we pretend the file is modified. 109 * NB: If stat() fails, we pretend the file is modified.
106 */ 110 */
107static int is_modified(struct cache_slot *slot) 111static int is_modified(struct cache_slot *slot)
108{ 112{
109 struct stat st; 113 struct stat st;
110 114
111 if (stat(slot->cache_name, &st)) 115 if (stat(slot->cache_name, &st))
112 return 1; 116 return 1;
113 return (st.st_ino != slot->cache_st.st_ino || 117 return (st.st_ino != slot->cache_st.st_ino ||
114 st.st_mtime != slot->cache_st.st_mtime || 118 st.st_mtime != slot->cache_st.st_mtime ||
115 st.st_size != slot->cache_st.st_size); 119 st.st_size != slot->cache_st.st_size);
116} 120}
117 121
118/* Close an open lockfile */ 122/* Close an open lockfile */
119static void close_lock(struct cache_slot *slot) 123static int close_lock(struct cache_slot *slot)
120{ 124{
125 int err = 0;
121 if (slot->lock_fd > 0) { 126 if (slot->lock_fd > 0) {
122 close(slot->lock_fd); 127 if (close(slot->lock_fd))
123 slot->lock_fd = -1; 128 err = errno;
129 else
130 slot->lock_fd = -1;
124 } 131 }
132 return err;
125} 133}
126 134
127/* Create a lockfile used to store the generated content for a cache 135/* Create a lockfile used to store the generated content for a cache
128 * slot, and write the slot key + \0 into it. 136 * slot, and write the slot key + \0 into it.
129 * Returns 0 on success and errno otherwise. 137 * Returns 0 on success and errno otherwise.
130 */ 138 */
131static int lock_slot(struct cache_slot *slot) 139static int lock_slot(struct cache_slot *slot)
132{ 140{
133 slot->lock_fd = open(slot->lock_name, O_RDWR|O_CREAT|O_EXCL, 141 slot->lock_fd = open(slot->lock_name, O_RDWR|O_CREAT|O_EXCL,
134 S_IRUSR|S_IWUSR); 142 S_IRUSR|S_IWUSR);
135 if (slot->lock_fd == -1) 143 if (slot->lock_fd == -1)
136 return errno; 144 return errno;
137 write(slot->lock_fd, slot->key, slot->keylen + 1); 145 if (write(slot->lock_fd, slot->key, slot->keylen + 1) < 0)
146 return errno;
138 return 0; 147 return 0;
139} 148}
140 149
141/* Release the current lockfile. If `replace_old_slot` is set the 150/* Release the current lockfile. If `replace_old_slot` is set the
142 * lockfile replaces the old cache slot, otherwise the lockfile is 151 * lockfile replaces the old cache slot, otherwise the lockfile is
143 * just deleted. 152 * just deleted.
144 */ 153 */
145static int unlock_slot(struct cache_slot *slot, int replace_old_slot) 154static int unlock_slot(struct cache_slot *slot, int replace_old_slot)
146{ 155{
147 int err; 156 int err;
148 157
149 if (replace_old_slot) 158 if (replace_old_slot)
150 err = rename(slot->lock_name, slot->cache_name); 159 err = rename(slot->lock_name, slot->cache_name);
151 else 160 else
152 err = unlink(slot->lock_name); 161 err = unlink(slot->lock_name);
153 return err; 162
163 if (err)
164 return errno;
165
166 return 0;
154} 167}
155 168
156/* Generate the content for the current cache slot by redirecting 169/* Generate the content for the current cache slot by redirecting
157 * stdout to the lock-fd and invoking the callback function 170 * stdout to the lock-fd and invoking the callback function
158 */ 171 */
159static int fill_slot(struct cache_slot *slot) 172static int fill_slot(struct cache_slot *slot)
160{ 173{
161 int tmp; 174 int tmp;
162 175
163 /* Preserve stdout */ 176 /* Preserve stdout */
164 tmp = dup(STDOUT_FILENO); 177 tmp = dup(STDOUT_FILENO);
165 if (tmp == -1) 178 if (tmp == -1)
166 return errno; 179 return errno;
167 180
168 /* Redirect stdout to lockfile */ 181 /* Redirect stdout to lockfile */
169 if (dup2(slot->lock_fd, STDOUT_FILENO) == -1) 182 if (dup2(slot->lock_fd, STDOUT_FILENO) == -1)
170 return errno; 183 return errno;
171 184
172 /* Generate cache content */ 185 /* Generate cache content */
173 slot->fn(slot->cbdata); 186 slot->fn(slot->cbdata);
174 187
175 /* Restore stdout */ 188 /* Restore stdout */
176 if (dup2(tmp, STDOUT_FILENO) == -1) 189 if (dup2(tmp, STDOUT_FILENO) == -1)
177 return errno; 190 return errno;
178 191
179 /* Close the temporary filedescriptor */ 192 /* Close the temporary filedescriptor */
180 close(tmp); 193 if (close(tmp))
194 return errno;
195
181 return 0; 196 return 0;
182} 197}
183 198
184/* Crude implementation of 32-bit FNV-1 hash algorithm, 199/* Crude implementation of 32-bit FNV-1 hash algorithm,
185 * see http://www.isthe.com/chongo/tech/comp/fnv/ for details 200 * see http://www.isthe.com/chongo/tech/comp/fnv/ for details
186 * about the magic numbers. 201 * about the magic numbers.
187 */ 202 */
188#define FNV_OFFSET 0x811c9dc5 203#define FNV_OFFSET 0x811c9dc5
189#define FNV_PRIME 0x01000193 204#define FNV_PRIME 0x01000193
190 205
191unsigned long hash_str(const char *str) 206unsigned long hash_str(const char *str)
192{ 207{
193 unsigned long h = FNV_OFFSET; 208 unsigned long h = FNV_OFFSET;
194 unsigned char *s = (unsigned char *)str; 209 unsigned char *s = (unsigned char *)str;
195 210
196 if (!s) 211 if (!s)
197 return h; 212 return h;
198 213
199 while(*s) { 214 while(*s) {
200 h *= FNV_PRIME; 215 h *= FNV_PRIME;
201 h ^= *s++; 216 h ^= *s++;
202 } 217 }
203 return h; 218 return h;
204} 219}
205 220
206static int process_slot(struct cache_slot *slot) 221static int process_slot(struct cache_slot *slot)
207{ 222{
208 int err; 223 int err;
209 224
210 err = open_slot(slot); 225 err = open_slot(slot);
211 if (!err && slot->match) { 226 if (!err && slot->match) {
212 if (is_expired(slot)) { 227 if (is_expired(slot)) {
213 if (!lock_slot(slot)) { 228 if (!lock_slot(slot)) {
214 /* If the cachefile has been replaced between 229 /* If the cachefile has been replaced between
215 * `open_slot` and `lock_slot`, we'll just 230 * `open_slot` and `lock_slot`, we'll just
216 * serve the stale content from the original 231 * serve the stale content from the original
217 * cachefile. This way we avoid pruning the 232 * cachefile. This way we avoid pruning the
218 * newly generated slot. The same code-path 233 * newly generated slot. The same code-path
219 * is chosen if fill_slot() fails for some 234 * is chosen if fill_slot() fails for some
220 * reason. 235 * reason.
221 * 236 *
222 * TODO? check if the new slot contains the 237 * TODO? check if the new slot contains the
223 * same key as the old one, since we would 238 * same key as the old one, since we would
224 * prefer to serve the newest content. 239 * prefer to serve the newest content.
225 * This will require us to open yet another 240 * This will require us to open yet another
226 * file-descriptor and read and compare the 241 * file-descriptor and read and compare the
227 * key from the new file, so for now we're 242 * key from the new file, so for now we're
228 * lazy and just ignore the new file. 243 * lazy and just ignore the new file.
229 */ 244 */
230 if (is_modified(slot) || fill_slot(slot)) { 245 if (is_modified(slot) || fill_slot(slot)) {
231 unlock_slot(slot, 0); 246 unlock_slot(slot, 0);
232 close_lock(slot); 247 close_lock(slot);
233 } else { 248 } else {
234 close_slot(slot); 249 close_slot(slot);
235 unlock_slot(slot, 1); 250 unlock_slot(slot, 1);
236 slot->cache_fd = slot->lock_fd; 251 slot->cache_fd = slot->lock_fd;
237 } 252 }
238 } 253 }
239 } 254 }
240 print_slot(slot); 255 print_slot(slot);
241 close_slot(slot); 256 close_slot(slot);
242 return 0; 257 return 0;
243 } 258 }
244 259
245 /* If the cache slot does not exist (or its key doesn't match the 260 /* If the cache slot does not exist (or its key doesn't match the
246 * current key), lets try to create a new cache slot for this 261 * current key), lets try to create a new cache slot for this
247 * request. If this fails (for whatever reason), lets just generate 262 * request. If this fails (for whatever reason), lets just generate
248 * the content without caching it and fool the caller to belive 263 * the content without caching it and fool the caller to belive
249 * everything worked out (but print a warning on stdout). 264 * everything worked out (but print a warning on stdout).
250 */ 265 */
251 266
252 close_slot(slot); 267 close_slot(slot);
253 if ((err = lock_slot(slot)) != 0) { 268 if ((err = lock_slot(slot)) != 0) {
254 cache_log("[cgit] Unable to lock slot %s: %s (%d)\n", 269 cache_log("[cgit] Unable to lock slot %s: %s (%d)\n",
255 slot->lock_name, strerror(err), err); 270 slot->lock_name, strerror(err), err);
256 slot->fn(slot->cbdata); 271 slot->fn(slot->cbdata);
257 return 0; 272 return 0;
258 } 273 }
259 274
260 if ((err = fill_slot(slot)) != 0) { 275 if ((err = fill_slot(slot)) != 0) {
261 cache_log("[cgit] Unable to fill slot %s: %s (%d)\n", 276 cache_log("[cgit] Unable to fill slot %s: %s (%d)\n",
262 slot->lock_name, strerror(err), err); 277 slot->lock_name, strerror(err), err);
263 unlock_slot(slot, 0); 278 unlock_slot(slot, 0);
264 close_lock(slot); 279 close_lock(slot);
265 slot->fn(slot->cbdata); 280 slot->fn(slot->cbdata);
266 return 0; 281 return 0;
267 } 282 }
268 // We've got a valid cache slot in the lock file, which 283 // We've got a valid cache slot in the lock file, which
269 // is about to replace the old cache slot. But if we 284 // is about to replace the old cache slot. But if we
270 // release the lockfile and then try to open the new cache 285 // release the lockfile and then try to open the new cache
271 // slot, we might get a race condition with a concurrent 286 // slot, we might get a race condition with a concurrent
272 // writer for the same cache slot (with a different key). 287 // writer for the same cache slot (with a different key).
273 // Lets avoid such a race by just printing the content of 288 // Lets avoid such a race by just printing the content of
274 // the lock file. 289 // the lock file.
275 slot->cache_fd = slot->lock_fd; 290 slot->cache_fd = slot->lock_fd;
276 unlock_slot(slot, 1); 291 unlock_slot(slot, 1);
277 err = print_slot(slot); 292 err = print_slot(slot);
278 close_slot(slot); 293 close_slot(slot);
279 return err; 294 return err;
280} 295}
281 296
282/* Print cached content to stdout, generate the content if necessary. */ 297/* Print cached content to stdout, generate the content if necessary. */
283int cache_process(int size, const char *path, const char *key, int ttl, 298int cache_process(int size, const char *path, const char *key, int ttl,
284 cache_fill_fn fn, void *cbdata) 299 cache_fill_fn fn, void *cbdata)
285{ 300{
286 unsigned long hash; 301 unsigned long hash;
287 int len, i; 302 int len, i;
288 char filename[1024]; 303 char filename[1024];
289 char lockname[1024 + 5]; /* 5 = ".lock" */ 304 char lockname[1024 + 5]; /* 5 = ".lock" */
290 struct cache_slot slot; 305 struct cache_slot slot;
291 306
292 /* If the cache is disabled, just generate the content */ 307 /* If the cache is disabled, just generate the content */
293 if (size <= 0) { 308 if (size <= 0) {
294 fn(cbdata); 309 fn(cbdata);
295 return 0; 310 return 0;
296 } 311 }
297 312
298 /* Verify input, calculate filenames */ 313 /* Verify input, calculate filenames */
299 if (!path) { 314 if (!path) {
300 cache_log("[cgit] Cache path not specified, caching is disabled\n"); 315 cache_log("[cgit] Cache path not specified, caching is disabled\n");
301 fn(cbdata); 316 fn(cbdata);
302 return 0; 317 return 0;
303 } 318 }
304 len = strlen(path); 319 len = strlen(path);
305 if (len > sizeof(filename) - 10) { /* 10 = "/01234567\0" */ 320 if (len > sizeof(filename) - 10) { /* 10 = "/01234567\0" */
306 cache_log("[cgit] Cache path too long, caching is disabled: %s\n", 321 cache_log("[cgit] Cache path too long, caching is disabled: %s\n",
307 path); 322 path);
308 fn(cbdata); 323 fn(cbdata);