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 2048
45 #define GOT_OBJECT_CACHE_SIZE_RAW 64
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, void *item)
150 const struct got_error *err = NULL;
151 struct got_object_cache_entry *ce;
155 switch (cache->type) {
156 case GOT_OBJECT_CACHE_TYPE_OBJ:
157 size = get_size_obj((struct got_object *)item);
159 case GOT_OBJECT_CACHE_TYPE_TREE:
160 size = get_size_tree((struct got_tree_object *)item);
162 case GOT_OBJECT_CACHE_TYPE_COMMIT:
163 size = get_size_commit((struct got_commit_object *)item);
165 case GOT_OBJECT_CACHE_TYPE_TAG:
166 size = get_size_tag((struct got_tag_object *)item);
168 case GOT_OBJECT_CACHE_TYPE_RAW:
169 size = get_size_raw((struct got_raw_object *)item);
172 return got_error(GOT_ERR_OBJ_TYPE);
175 if (size > GOT_OBJECT_CACHE_MAX_ELEM_SIZE) {
176 #ifdef GOT_OBJ_CACHE_DEBUG
178 if (got_object_id_str(&id_str, id) != NULL)
179 return got_error_from_errno("got_object_id_str");
180 fprintf(stderr, "%s: not caching ", getprogname());
181 switch (cache->type) {
182 case GOT_OBJECT_CACHE_TYPE_OBJ:
183 fprintf(stderr, "object");
185 case GOT_OBJECT_CACHE_TYPE_TREE:
186 fprintf(stderr, "tree");
188 case GOT_OBJECT_CACHE_TYPE_COMMIT:
189 fprintf(stderr, "commit");
191 case GOT_OBJECT_CACHE_TYPE_TAG:
192 fprintf(stderr, "tag");
194 case GOT_OBJECT_CACHE_TYPE_RAW:
195 fprintf(stderr, "raw");
198 fprintf(stderr, " %s (%zd bytes; %zd MB)\n", id_str, size,
202 cache->cache_toolarge++;
203 return got_error(GOT_ERR_OBJ_TOO_LARGE);
206 nelem = got_object_idset_num_elements(cache->idset);
207 if (nelem >= cache->size) {
208 err = got_object_idset_remove((void **)&ce,
212 switch (cache->type) {
213 case GOT_OBJECT_CACHE_TYPE_OBJ:
214 got_object_close(ce->data.obj);
216 case GOT_OBJECT_CACHE_TYPE_TREE:
217 got_object_tree_close(ce->data.tree);
219 case GOT_OBJECT_CACHE_TYPE_COMMIT:
220 got_object_commit_close(ce->data.commit);
222 case GOT_OBJECT_CACHE_TYPE_TAG:
223 got_object_tag_close(ce->data.tag);
225 case GOT_OBJECT_CACHE_TYPE_RAW:
226 got_object_raw_close(ce->data.raw);
230 cache->cache_evict++;
233 ce = malloc(sizeof(*ce));
235 return got_error_from_errno("malloc");
236 memcpy(&ce->id, id, sizeof(ce->id));
237 switch (cache->type) {
238 case GOT_OBJECT_CACHE_TYPE_OBJ:
239 ce->data.obj = (struct got_object *)item;
241 case GOT_OBJECT_CACHE_TYPE_TREE:
242 ce->data.tree = (struct got_tree_object *)item;
244 case GOT_OBJECT_CACHE_TYPE_COMMIT:
245 ce->data.commit = (struct got_commit_object *)item;
247 case GOT_OBJECT_CACHE_TYPE_TAG:
248 ce->data.tag = (struct got_tag_object *)item;
250 case GOT_OBJECT_CACHE_TYPE_RAW:
251 ce->data.raw = (struct got_raw_object *)item;
255 err = got_object_idset_add(cache->idset, id, ce);
262 got_object_cache_get(struct got_object_cache *cache, struct got_object_id *id)
264 struct got_object_cache_entry *ce;
266 cache->cache_searches++;
267 ce = got_object_idset_get(cache->idset, id);
270 switch (cache->type) {
271 case GOT_OBJECT_CACHE_TYPE_OBJ:
273 case GOT_OBJECT_CACHE_TYPE_TREE:
274 return ce->data.tree;
275 case GOT_OBJECT_CACHE_TYPE_COMMIT:
276 return ce->data.commit;
277 case GOT_OBJECT_CACHE_TYPE_TAG:
279 case GOT_OBJECT_CACHE_TYPE_RAW:
288 #ifdef GOT_OBJ_CACHE_DEBUG
290 print_cache_stats(struct got_object_cache *cache, const char *name)
292 fprintf(stderr, "%s: %s cache: %d elements, %d searches, %d hits, "
293 "%d missed, %d evicted, %d too large\n", getprogname(), name,
294 got_object_idset_num_elements(cache->idset),
295 cache->cache_searches, cache->cache_hit,
296 cache->cache_miss, cache->cache_evict, cache->cache_toolarge);
299 const struct got_error *
300 check_refcount(struct got_object_id *id, void *data, void *arg)
302 struct got_object_cache *cache = arg;
303 struct got_object_cache_entry *ce = data;
304 struct got_object *obj;
305 struct got_tree_object *tree;
306 struct got_commit_object *commit;
307 struct got_tag_object *tag;
308 struct got_raw_object *raw;
311 if (got_object_id_str(&id_str, id) != NULL)
314 switch (cache->type) {
315 case GOT_OBJECT_CACHE_TYPE_OBJ:
317 if (obj->refcnt == 1)
319 fprintf(stderr, "object %s has %d unclaimed references\n",
320 id_str, obj->refcnt - 1);
322 case GOT_OBJECT_CACHE_TYPE_TREE:
323 tree = ce->data.tree;
324 if (tree->refcnt == 1)
326 fprintf(stderr, "tree %s has %d unclaimed references\n",
327 id_str, tree->refcnt - 1);
329 case GOT_OBJECT_CACHE_TYPE_COMMIT:
330 commit = ce->data.commit;
331 if (commit->refcnt == 1)
333 fprintf(stderr, "commit %s has %d unclaimed references\n",
334 id_str, commit->refcnt - 1);
336 case GOT_OBJECT_CACHE_TYPE_TAG:
338 if (tag->refcnt == 1)
340 fprintf(stderr, "tag %s has %d unclaimed references\n",
341 id_str, tag->refcnt - 1);
343 case GOT_OBJECT_CACHE_TYPE_RAW:
345 if (raw->refcnt == 1)
347 fprintf(stderr, "raw %s has %d unclaimed references\n",
348 id_str, raw->refcnt - 1);
357 got_object_cache_close(struct got_object_cache *cache)
359 #ifdef GOT_OBJ_CACHE_DEBUG
360 switch (cache->type) {
361 case GOT_OBJECT_CACHE_TYPE_OBJ:
362 print_cache_stats(cache, "object");
364 case GOT_OBJECT_CACHE_TYPE_TREE:
365 print_cache_stats(cache, "tree");
367 case GOT_OBJECT_CACHE_TYPE_COMMIT:
368 print_cache_stats(cache, "commit");
370 case GOT_OBJECT_CACHE_TYPE_TAG:
371 print_cache_stats(cache, "tag");
373 case GOT_OBJECT_CACHE_TYPE_RAW:
374 print_cache_stats(cache, "raw");
378 got_object_idset_for_each(cache->idset, check_refcount, cache);
382 got_object_idset_free(cache->idset);