2 * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 #include <sys/queue.h>
19 #include <sys/resource.h>
28 #include "got_error.h"
29 #include "got_object.h"
31 #include "got_lib_delta.h"
32 #include "got_lib_inflate.h"
33 #include "got_lib_object.h"
34 #include "got_lib_object_idset.h"
35 #include "got_lib_object_cache.h"
38 * XXX This should be reworked to track cache size and usage in bytes,
39 * rather than tracking N elements capped to a maximum element size.
41 #define GOT_OBJECT_CACHE_SIZE_OBJ 256
42 #define GOT_OBJECT_CACHE_SIZE_TREE 256
43 #define GOT_OBJECT_CACHE_SIZE_COMMIT 64
44 #define GOT_OBJECT_CACHE_SIZE_TAG 256
45 #define GOT_OBJECT_CACHE_SIZE_RAW 16
46 #define GOT_OBJECT_CACHE_MAX_ELEM_SIZE 1048576 /* 1 MB */
48 const struct got_error *
49 got_object_cache_init(struct got_object_cache *cache,
50 enum got_object_cache_type type)
54 memset(cache, 0, sizeof(*cache));
56 cache->idset = got_object_idset_alloc();
57 if (cache->idset == NULL)
58 return got_error_from_errno("got_object_idset_alloc");
62 case GOT_OBJECT_CACHE_TYPE_OBJ:
63 cache->size = GOT_OBJECT_CACHE_SIZE_OBJ;
65 case GOT_OBJECT_CACHE_TYPE_TREE:
66 cache->size = GOT_OBJECT_CACHE_SIZE_TREE;
68 case GOT_OBJECT_CACHE_TYPE_COMMIT:
69 cache->size = GOT_OBJECT_CACHE_SIZE_COMMIT;
71 case GOT_OBJECT_CACHE_TYPE_TAG:
72 cache->size = GOT_OBJECT_CACHE_SIZE_TAG;
74 case GOT_OBJECT_CACHE_TYPE_RAW:
75 if (getrlimit(RLIMIT_NOFILE, &rl) == -1)
76 return got_error_from_errno("getrlimit");
77 cache->size = GOT_OBJECT_CACHE_SIZE_RAW;
78 if (cache->size > rl.rlim_cur / 16)
79 cache->size = rl.rlim_cur / 16;
86 get_size_obj(struct got_object *obj)
88 size_t size = sizeof(*obj);
89 struct got_delta *delta;
91 if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0)
94 STAILQ_FOREACH(delta, &obj->deltas.entries, entry) {
95 if (SIZE_MAX - sizeof(*delta) < size)
97 size += sizeof(*delta);
104 get_size_tree(struct got_tree_object *tree)
106 size_t size = sizeof(*tree);
108 size += sizeof(struct got_tree_entry) * tree->nentries;
113 get_size_commit(struct got_commit_object *commit)
115 size_t size = sizeof(*commit);
116 struct got_object_qid *qid;
118 size += sizeof(*commit->tree_id);
119 size += strlen(commit->author);
120 size += strlen(commit->committer);
121 size += strlen(commit->logmsg);
123 STAILQ_FOREACH(qid, &commit->parent_ids, entry)
124 size += sizeof(*qid) + sizeof(qid->id);
130 get_size_tag(struct got_tag_object *tag)
132 size_t size = sizeof(*tag);
134 size += strlen(tag->tag);
135 size += strlen(tag->tagger);
136 size += strlen(tag->tagmsg);
142 get_size_raw(struct got_raw_object *raw)
147 const struct got_error *
148 got_object_cache_add(struct got_object_cache *cache, struct got_object_id *id,
151 const struct got_error *err = NULL;
152 struct got_object_cache_entry *ce;
156 switch (cache->type) {
157 case GOT_OBJECT_CACHE_TYPE_OBJ:
158 size = get_size_obj((struct got_object *)item);
160 case GOT_OBJECT_CACHE_TYPE_TREE:
161 size = get_size_tree((struct got_tree_object *)item);
163 case GOT_OBJECT_CACHE_TYPE_COMMIT:
164 size = get_size_commit((struct got_commit_object *)item);
166 case GOT_OBJECT_CACHE_TYPE_TAG:
167 size = get_size_tag((struct got_tag_object *)item);
169 case GOT_OBJECT_CACHE_TYPE_RAW:
170 size = get_size_raw((struct got_raw_object *)item);
173 return got_error(GOT_ERR_OBJ_TYPE);
176 if (size > GOT_OBJECT_CACHE_MAX_ELEM_SIZE) {
177 #ifdef GOT_OBJ_CACHE_DEBUG
179 if (got_object_id_str(&id_str, id) != NULL)
180 return got_error_from_errno("got_object_id_str");
181 fprintf(stderr, "%s: not caching ", getprogname());
182 switch (cache->type) {
183 case GOT_OBJECT_CACHE_TYPE_OBJ:
184 fprintf(stderr, "object");
186 case GOT_OBJECT_CACHE_TYPE_TREE:
187 fprintf(stderr, "tree");
189 case GOT_OBJECT_CACHE_TYPE_COMMIT:
190 fprintf(stderr, "commit");
192 case GOT_OBJECT_CACHE_TYPE_TAG:
193 fprintf(stderr, "tag");
195 case GOT_OBJECT_CACHE_TYPE_RAW:
196 fprintf(stderr, "raw");
199 fprintf(stderr, " %s (%zd bytes; %zd MB)\n", id_str, size,
203 cache->cache_toolarge++;
204 return got_error(GOT_ERR_OBJ_TOO_LARGE);
207 nelem = got_object_idset_num_elements(cache->idset);
208 if (nelem >= cache->size) {
209 err = got_object_idset_remove((void **)&ce,
213 switch (cache->type) {
214 case GOT_OBJECT_CACHE_TYPE_OBJ:
215 got_object_close(ce->data.obj);
217 case GOT_OBJECT_CACHE_TYPE_TREE:
218 got_object_tree_close(ce->data.tree);
220 case GOT_OBJECT_CACHE_TYPE_COMMIT:
221 got_object_commit_close(ce->data.commit);
223 case GOT_OBJECT_CACHE_TYPE_TAG:
224 got_object_tag_close(ce->data.tag);
226 case GOT_OBJECT_CACHE_TYPE_RAW:
227 got_object_raw_close(ce->data.raw);
230 memset(ce, 0, sizeof(*ce));
231 cache->cache_evict++;
233 ce = malloc(sizeof(*ce));
235 return got_error_from_errno("malloc");
238 memcpy(&ce->id, id, sizeof(ce->id));
239 switch (cache->type) {
240 case GOT_OBJECT_CACHE_TYPE_OBJ:
241 ce->data.obj = (struct got_object *)item;
243 case GOT_OBJECT_CACHE_TYPE_TREE:
244 ce->data.tree = (struct got_tree_object *)item;
246 case GOT_OBJECT_CACHE_TYPE_COMMIT:
247 ce->data.commit = (struct got_commit_object *)item;
249 case GOT_OBJECT_CACHE_TYPE_TAG:
250 ce->data.tag = (struct got_tag_object *)item;
252 case GOT_OBJECT_CACHE_TYPE_RAW:
253 ce->data.raw = (struct got_raw_object *)item;
257 err = got_object_idset_add(cache->idset, id, ce);
260 else if (size > cache->max_cached_size)
261 cache->max_cached_size = size;
266 got_object_cache_get(struct got_object_cache *cache, struct got_object_id *id)
268 struct got_object_cache_entry *ce;
270 cache->cache_searches++;
271 ce = got_object_idset_get(cache->idset, id);
274 switch (cache->type) {
275 case GOT_OBJECT_CACHE_TYPE_OBJ:
277 case GOT_OBJECT_CACHE_TYPE_TREE:
278 return ce->data.tree;
279 case GOT_OBJECT_CACHE_TYPE_COMMIT:
280 return ce->data.commit;
281 case GOT_OBJECT_CACHE_TYPE_TAG:
283 case GOT_OBJECT_CACHE_TYPE_RAW:
292 #ifdef GOT_OBJ_CACHE_DEBUG
294 print_cache_stats(struct got_object_cache *cache, const char *name)
296 fprintf(stderr, "%s: %s cache: %d elements, %d searches, %d hits, "
297 "%d missed, %d evicted, %d too large, max cached %zd bytes\n",
299 cache->idset ? got_object_idset_num_elements(cache->idset) : -1,
300 cache->cache_searches, cache->cache_hit,
301 cache->cache_miss, cache->cache_evict, cache->cache_toolarge,
302 cache->max_cached_size);
305 static const struct got_error *
306 check_refcount(struct got_object_id *id, void *data, void *arg)
308 struct got_object_cache *cache = arg;
309 struct got_object_cache_entry *ce = data;
310 struct got_object *obj;
311 struct got_tree_object *tree;
312 struct got_commit_object *commit;
313 struct got_tag_object *tag;
314 struct got_raw_object *raw;
317 if (got_object_id_str(&id_str, id) != NULL)
320 switch (cache->type) {
321 case GOT_OBJECT_CACHE_TYPE_OBJ:
323 if (obj->refcnt == 1)
325 fprintf(stderr, "object %s has %d unclaimed references\n",
326 id_str, obj->refcnt - 1);
328 case GOT_OBJECT_CACHE_TYPE_TREE:
329 tree = ce->data.tree;
330 if (tree->refcnt == 1)
332 fprintf(stderr, "tree %s has %d unclaimed references\n",
333 id_str, tree->refcnt - 1);
335 case GOT_OBJECT_CACHE_TYPE_COMMIT:
336 commit = ce->data.commit;
337 if (commit->refcnt == 1)
339 fprintf(stderr, "commit %s has %d unclaimed references\n",
340 id_str, commit->refcnt - 1);
342 case GOT_OBJECT_CACHE_TYPE_TAG:
344 if (tag->refcnt == 1)
346 fprintf(stderr, "tag %s has %d unclaimed references\n",
347 id_str, tag->refcnt - 1);
349 case GOT_OBJECT_CACHE_TYPE_RAW:
351 if (raw->refcnt == 1)
353 fprintf(stderr, "raw %s has %d unclaimed references\n",
354 id_str, raw->refcnt - 1);
362 static const struct got_error *
363 free_entry(struct got_object_id *id, void *data, void *arg)
365 struct got_object_cache *cache = arg;
366 struct got_object_cache_entry *ce = data;
368 switch (cache->type) {
369 case GOT_OBJECT_CACHE_TYPE_OBJ:
370 got_object_close(ce->data.obj);
372 case GOT_OBJECT_CACHE_TYPE_TREE:
373 got_object_tree_close(ce->data.tree);
375 case GOT_OBJECT_CACHE_TYPE_COMMIT:
376 got_object_commit_close(ce->data.commit);
378 case GOT_OBJECT_CACHE_TYPE_TAG:
379 got_object_tag_close(ce->data.tag);
381 case GOT_OBJECT_CACHE_TYPE_RAW:
382 got_object_raw_close(ce->data.raw);
392 got_object_cache_close(struct got_object_cache *cache)
394 #ifdef GOT_OBJ_CACHE_DEBUG
395 switch (cache->type) {
396 case GOT_OBJECT_CACHE_TYPE_OBJ:
397 print_cache_stats(cache, "object");
399 case GOT_OBJECT_CACHE_TYPE_TREE:
400 print_cache_stats(cache, "tree");
402 case GOT_OBJECT_CACHE_TYPE_COMMIT:
403 print_cache_stats(cache, "commit");
405 case GOT_OBJECT_CACHE_TYPE_TAG:
406 print_cache_stats(cache, "tag");
408 case GOT_OBJECT_CACHE_TYPE_RAW:
409 print_cache_stats(cache, "raw");
414 got_object_idset_for_each(cache->idset, check_refcount, cache);
418 got_object_idset_for_each(cache->idset, free_entry, cache);
419 got_object_idset_free(cache->idset);