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>
29 #include "got_error.h"
30 #include "got_object.h"
32 #include "got_lib_delta.h"
33 #include "got_lib_inflate.h"
34 #include "got_lib_object.h"
35 #include "got_lib_object_idset.h"
36 #include "got_lib_object_cache.h"
39 * XXX This should be reworked to track cache size and usage in bytes,
40 * rather than tracking N elements capped to a maximum element size.
42 #define GOT_OBJECT_CACHE_SIZE_OBJ 256
43 #define GOT_OBJECT_CACHE_SIZE_TREE 256
44 #define GOT_OBJECT_CACHE_SIZE_COMMIT 64
45 #define GOT_OBJECT_CACHE_SIZE_TAG 2048
46 #define GOT_OBJECT_CACHE_SIZE_RAW 64
47 #define GOT_OBJECT_CACHE_MAX_ELEM_SIZE 1048576 /* 1 MB */
49 const struct got_error *
50 got_object_cache_init(struct got_object_cache *cache,
51 enum got_object_cache_type type)
55 memset(cache, 0, sizeof(*cache));
57 cache->idset = got_object_idset_alloc();
58 if (cache->idset == NULL)
59 return got_error_from_errno("got_object_idset_alloc");
63 case GOT_OBJECT_CACHE_TYPE_OBJ:
64 cache->size = GOT_OBJECT_CACHE_SIZE_OBJ;
66 case GOT_OBJECT_CACHE_TYPE_TREE:
67 cache->size = GOT_OBJECT_CACHE_SIZE_TREE;
69 case GOT_OBJECT_CACHE_TYPE_COMMIT:
70 cache->size = GOT_OBJECT_CACHE_SIZE_COMMIT;
72 case GOT_OBJECT_CACHE_TYPE_TAG:
73 cache->size = GOT_OBJECT_CACHE_SIZE_TAG;
75 case GOT_OBJECT_CACHE_TYPE_RAW:
76 if (getrlimit(RLIMIT_NOFILE, &rl) == -1)
77 return got_error_from_errno("getrlimit");
78 cache->size = GOT_OBJECT_CACHE_SIZE_RAW;
79 if (cache->size > rl.rlim_cur / 16)
80 cache->size = rl.rlim_cur / 16;
87 get_size_obj(struct got_object *obj)
89 size_t size = sizeof(*obj);
90 struct got_delta *delta;
92 if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0)
95 STAILQ_FOREACH(delta, &obj->deltas.entries, entry) {
96 if (SIZE_MAX - sizeof(*delta) < size)
98 size += sizeof(*delta);
105 get_size_tree(struct got_tree_object *tree)
107 size_t size = sizeof(*tree);
109 size += sizeof(struct got_tree_entry) * tree->nentries;
114 get_size_commit(struct got_commit_object *commit)
116 size_t size = sizeof(*commit);
117 struct got_object_qid *qid;
119 size += sizeof(*commit->tree_id);
120 size += strlen(commit->author);
121 size += strlen(commit->committer);
122 size += strlen(commit->logmsg);
124 STAILQ_FOREACH(qid, &commit->parent_ids, entry)
125 size += sizeof(*qid) + sizeof(*qid->id);
131 get_size_tag(struct got_tag_object *tag)
133 size_t size = sizeof(*tag);
135 size += strlen(tag->tag);
136 size += strlen(tag->tagger);
137 size += strlen(tag->tagmsg);
143 get_size_raw(struct got_raw_object *raw)
148 const struct got_error *
149 got_object_cache_add(struct got_object_cache *cache, struct got_object_id *id, void *item)
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);
231 cache->cache_evict++;
234 ce = malloc(sizeof(*ce));
236 return got_error_from_errno("malloc");
237 memcpy(&ce->id, id, sizeof(ce->id));
238 switch (cache->type) {
239 case GOT_OBJECT_CACHE_TYPE_OBJ:
240 ce->data.obj = (struct got_object *)item;
242 case GOT_OBJECT_CACHE_TYPE_TREE:
243 ce->data.tree = (struct got_tree_object *)item;
245 case GOT_OBJECT_CACHE_TYPE_COMMIT:
246 ce->data.commit = (struct got_commit_object *)item;
248 case GOT_OBJECT_CACHE_TYPE_TAG:
249 ce->data.tag = (struct got_tag_object *)item;
251 case GOT_OBJECT_CACHE_TYPE_RAW:
252 ce->data.raw = (struct got_raw_object *)item;
256 err = got_object_idset_add(cache->idset, id, ce);
263 got_object_cache_get(struct got_object_cache *cache, struct got_object_id *id)
265 struct got_object_cache_entry *ce;
267 cache->cache_searches++;
268 ce = got_object_idset_get(cache->idset, id);
271 switch (cache->type) {
272 case GOT_OBJECT_CACHE_TYPE_OBJ:
274 case GOT_OBJECT_CACHE_TYPE_TREE:
275 return ce->data.tree;
276 case GOT_OBJECT_CACHE_TYPE_COMMIT:
277 return ce->data.commit;
278 case GOT_OBJECT_CACHE_TYPE_TAG:
280 case GOT_OBJECT_CACHE_TYPE_RAW:
289 #ifdef GOT_OBJ_CACHE_DEBUG
291 print_cache_stats(struct got_object_cache *cache, const char *name)
293 fprintf(stderr, "%s: %s cache: %d elements, %d searches, %d hits, "
294 "%d missed, %d evicted, %d too large\n", getprogname(), name,
295 got_object_idset_num_elements(cache->idset),
296 cache->cache_searches, cache->cache_hit,
297 cache->cache_miss, cache->cache_evict, cache->cache_toolarge);
300 const struct got_error *
301 check_refcount(struct got_object_id *id, void *data, void *arg)
303 struct got_object_cache *cache = arg;
304 struct got_object_cache_entry *ce = data;
305 struct got_object *obj;
306 struct got_tree_object *tree;
307 struct got_commit_object *commit;
308 struct got_tag_object *tag;
309 struct got_raw_object *raw;
312 if (got_object_id_str(&id_str, id) != NULL)
315 switch (cache->type) {
316 case GOT_OBJECT_CACHE_TYPE_OBJ:
318 if (obj->refcnt == 1)
320 fprintf(stderr, "object %s has %d unclaimed references\n",
321 id_str, obj->refcnt - 1);
323 case GOT_OBJECT_CACHE_TYPE_TREE:
324 tree = ce->data.tree;
325 if (tree->refcnt == 1)
327 fprintf(stderr, "tree %s has %d unclaimed references\n",
328 id_str, tree->refcnt - 1);
330 case GOT_OBJECT_CACHE_TYPE_COMMIT:
331 commit = ce->data.commit;
332 if (commit->refcnt == 1)
334 fprintf(stderr, "commit %s has %d unclaimed references\n",
335 id_str, commit->refcnt - 1);
337 case GOT_OBJECT_CACHE_TYPE_TAG:
339 if (tag->refcnt == 1)
341 fprintf(stderr, "tag %s has %d unclaimed references\n",
342 id_str, tag->refcnt - 1);
344 case GOT_OBJECT_CACHE_TYPE_RAW:
346 if (raw->refcnt == 1)
348 fprintf(stderr, "raw %s has %d unclaimed references\n",
349 id_str, raw->refcnt - 1);
358 got_object_cache_close(struct got_object_cache *cache)
360 #ifdef GOT_OBJ_CACHE_DEBUG
361 switch (cache->type) {
362 case GOT_OBJECT_CACHE_TYPE_OBJ:
363 print_cache_stats(cache, "object");
365 case GOT_OBJECT_CACHE_TYPE_TREE:
366 print_cache_stats(cache, "tree");
368 case GOT_OBJECT_CACHE_TYPE_COMMIT:
369 print_cache_stats(cache, "commit");
371 case GOT_OBJECT_CACHE_TYPE_TAG:
372 print_cache_stats(cache, "tag");
374 case GOT_OBJECT_CACHE_TYPE_RAW:
375 print_cache_stats(cache, "raw");
379 got_object_idset_for_each(cache->idset, check_refcount, cache);
383 got_object_idset_free(cache->idset);