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>
30 #include "got_error.h"
31 #include "got_object.h"
33 #include "got_lib_delta.h"
34 #include "got_lib_inflate.h"
35 #include "got_lib_object.h"
36 #include "got_lib_object_idset.h"
37 #include "got_lib_object_cache.h"
40 * XXX This should be reworked to track cache size and usage in bytes,
41 * rather than tracking N elements capped to a maximum element size.
43 #define GOT_OBJECT_CACHE_SIZE_OBJ 256
44 #define GOT_OBJECT_CACHE_SIZE_TREE 256
45 #define GOT_OBJECT_CACHE_SIZE_COMMIT 64
46 #define GOT_OBJECT_CACHE_SIZE_TAG 256
47 #define GOT_OBJECT_CACHE_SIZE_RAW 16
48 #define GOT_OBJECT_CACHE_MAX_ELEM_SIZE 1048576 /* 1 MB */
50 const struct got_error *
51 got_object_cache_init(struct got_object_cache *cache,
52 enum got_object_cache_type type)
56 memset(cache, 0, sizeof(*cache));
58 cache->idset = got_object_idset_alloc();
59 if (cache->idset == NULL)
60 return got_error_from_errno("got_object_idset_alloc");
64 case GOT_OBJECT_CACHE_TYPE_OBJ:
65 cache->size = GOT_OBJECT_CACHE_SIZE_OBJ;
67 case GOT_OBJECT_CACHE_TYPE_TREE:
68 cache->size = GOT_OBJECT_CACHE_SIZE_TREE;
70 case GOT_OBJECT_CACHE_TYPE_COMMIT:
71 cache->size = GOT_OBJECT_CACHE_SIZE_COMMIT;
73 case GOT_OBJECT_CACHE_TYPE_TAG:
74 cache->size = GOT_OBJECT_CACHE_SIZE_TAG;
76 case GOT_OBJECT_CACHE_TYPE_RAW:
77 if (getrlimit(RLIMIT_NOFILE, &rl) == -1)
78 return got_error_from_errno("getrlimit");
79 cache->size = GOT_OBJECT_CACHE_SIZE_RAW;
80 if (cache->size > rl.rlim_cur / 16)
81 cache->size = rl.rlim_cur / 16;
88 get_size_obj(struct got_object *obj)
90 size_t size = sizeof(*obj);
91 struct got_delta *delta;
93 if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0)
96 STAILQ_FOREACH(delta, &obj->deltas.entries, entry) {
97 if (SIZE_MAX - sizeof(*delta) < size)
99 size += sizeof(*delta);
106 get_size_tree(struct got_tree_object *tree)
108 size_t size = sizeof(*tree);
110 size += sizeof(struct got_tree_entry) * tree->nentries;
115 get_size_commit(struct got_commit_object *commit)
117 size_t size = sizeof(*commit);
118 struct got_object_qid *qid;
120 size += sizeof(*commit->tree_id);
121 size += strlen(commit->author);
122 size += strlen(commit->committer);
123 size += strlen(commit->logmsg);
125 STAILQ_FOREACH(qid, &commit->parent_ids, entry)
126 size += sizeof(*qid) + sizeof(qid->id);
132 get_size_tag(struct got_tag_object *tag)
134 size_t size = sizeof(*tag);
136 size += strlen(tag->tag);
137 size += strlen(tag->tagger);
138 size += strlen(tag->tagmsg);
144 get_size_raw(struct got_raw_object *raw)
149 const struct got_error *
150 got_object_cache_add(struct got_object_cache *cache, struct got_object_id *id,
153 const struct got_error *err = NULL;
154 struct got_object_cache_entry *ce;
158 switch (cache->type) {
159 case GOT_OBJECT_CACHE_TYPE_OBJ:
160 size = get_size_obj((struct got_object *)item);
162 case GOT_OBJECT_CACHE_TYPE_TREE:
163 size = get_size_tree((struct got_tree_object *)item);
165 case GOT_OBJECT_CACHE_TYPE_COMMIT:
166 size = get_size_commit((struct got_commit_object *)item);
168 case GOT_OBJECT_CACHE_TYPE_TAG:
169 size = get_size_tag((struct got_tag_object *)item);
171 case GOT_OBJECT_CACHE_TYPE_RAW:
172 size = get_size_raw((struct got_raw_object *)item);
175 return got_error(GOT_ERR_OBJ_TYPE);
178 if (size > GOT_OBJECT_CACHE_MAX_ELEM_SIZE) {
179 #ifdef GOT_OBJ_CACHE_DEBUG
181 if (got_object_id_str(&id_str, id) != NULL)
182 return got_error_from_errno("got_object_id_str");
183 fprintf(stderr, "%s: not caching ", getprogname());
184 switch (cache->type) {
185 case GOT_OBJECT_CACHE_TYPE_OBJ:
186 fprintf(stderr, "object");
188 case GOT_OBJECT_CACHE_TYPE_TREE:
189 fprintf(stderr, "tree");
191 case GOT_OBJECT_CACHE_TYPE_COMMIT:
192 fprintf(stderr, "commit");
194 case GOT_OBJECT_CACHE_TYPE_TAG:
195 fprintf(stderr, "tag");
197 case GOT_OBJECT_CACHE_TYPE_RAW:
198 fprintf(stderr, "raw");
201 fprintf(stderr, " %s (%zd bytes; %zd MB)\n", id_str, size,
205 cache->cache_toolarge++;
206 return got_error(GOT_ERR_OBJ_TOO_LARGE);
209 nelem = got_object_idset_num_elements(cache->idset);
210 if (nelem >= cache->size) {
211 err = got_object_idset_remove((void **)&ce,
215 switch (cache->type) {
216 case GOT_OBJECT_CACHE_TYPE_OBJ:
217 got_object_close(ce->data.obj);
219 case GOT_OBJECT_CACHE_TYPE_TREE:
220 got_object_tree_close(ce->data.tree);
222 case GOT_OBJECT_CACHE_TYPE_COMMIT:
223 got_object_commit_close(ce->data.commit);
225 case GOT_OBJECT_CACHE_TYPE_TAG:
226 got_object_tag_close(ce->data.tag);
228 case GOT_OBJECT_CACHE_TYPE_RAW:
229 got_object_raw_close(ce->data.raw);
232 memset(ce, 0, sizeof(*ce));
233 cache->cache_evict++;
235 ce = malloc(sizeof(*ce));
237 return got_error_from_errno("malloc");
240 memcpy(&ce->id, id, sizeof(ce->id));
241 switch (cache->type) {
242 case GOT_OBJECT_CACHE_TYPE_OBJ:
243 ce->data.obj = (struct got_object *)item;
245 case GOT_OBJECT_CACHE_TYPE_TREE:
246 ce->data.tree = (struct got_tree_object *)item;
248 case GOT_OBJECT_CACHE_TYPE_COMMIT:
249 ce->data.commit = (struct got_commit_object *)item;
251 case GOT_OBJECT_CACHE_TYPE_TAG:
252 ce->data.tag = (struct got_tag_object *)item;
254 case GOT_OBJECT_CACHE_TYPE_RAW:
255 ce->data.raw = (struct got_raw_object *)item;
259 err = got_object_idset_add(cache->idset, id, ce);
262 else if (size > cache->max_cached_size)
263 cache->max_cached_size = size;
268 got_object_cache_get(struct got_object_cache *cache, struct got_object_id *id)
270 struct got_object_cache_entry *ce;
272 cache->cache_searches++;
273 ce = got_object_idset_get(cache->idset, id);
276 switch (cache->type) {
277 case GOT_OBJECT_CACHE_TYPE_OBJ:
279 case GOT_OBJECT_CACHE_TYPE_TREE:
280 return ce->data.tree;
281 case GOT_OBJECT_CACHE_TYPE_COMMIT:
282 return ce->data.commit;
283 case GOT_OBJECT_CACHE_TYPE_TAG:
285 case GOT_OBJECT_CACHE_TYPE_RAW:
294 #ifdef GOT_OBJ_CACHE_DEBUG
296 print_cache_stats(struct got_object_cache *cache, const char *name)
298 fprintf(stderr, "%s: %s cache: %d elements, %d searches, %d hits, "
299 "%d missed, %d evicted, %d too large, max cached %zd bytes\n",
301 cache->idset ? got_object_idset_num_elements(cache->idset) : -1,
302 cache->cache_searches, cache->cache_hit,
303 cache->cache_miss, cache->cache_evict, cache->cache_toolarge,
304 cache->max_cached_size);
307 static const struct got_error *
308 check_refcount(struct got_object_id *id, void *data, void *arg)
310 struct got_object_cache *cache = arg;
311 struct got_object_cache_entry *ce = data;
312 struct got_object *obj;
313 struct got_tree_object *tree;
314 struct got_commit_object *commit;
315 struct got_tag_object *tag;
316 struct got_raw_object *raw;
319 if (got_object_id_str(&id_str, id) != NULL)
322 switch (cache->type) {
323 case GOT_OBJECT_CACHE_TYPE_OBJ:
325 if (obj->refcnt == 1)
327 fprintf(stderr, "object %s has %d unclaimed references\n",
328 id_str, obj->refcnt - 1);
330 case GOT_OBJECT_CACHE_TYPE_TREE:
331 tree = ce->data.tree;
332 if (tree->refcnt == 1)
334 fprintf(stderr, "tree %s has %d unclaimed references\n",
335 id_str, tree->refcnt - 1);
337 case GOT_OBJECT_CACHE_TYPE_COMMIT:
338 commit = ce->data.commit;
339 if (commit->refcnt == 1)
341 fprintf(stderr, "commit %s has %d unclaimed references\n",
342 id_str, commit->refcnt - 1);
344 case GOT_OBJECT_CACHE_TYPE_TAG:
346 if (tag->refcnt == 1)
348 fprintf(stderr, "tag %s has %d unclaimed references\n",
349 id_str, tag->refcnt - 1);
351 case GOT_OBJECT_CACHE_TYPE_RAW:
353 if (raw->refcnt == 1)
355 fprintf(stderr, "raw %s has %d unclaimed references\n",
356 id_str, raw->refcnt - 1);
364 static const struct got_error *
365 free_entry(struct got_object_id *id, void *data, void *arg)
367 struct got_object_cache *cache = arg;
368 struct got_object_cache_entry *ce = data;
370 switch (cache->type) {
371 case GOT_OBJECT_CACHE_TYPE_OBJ:
372 got_object_close(ce->data.obj);
374 case GOT_OBJECT_CACHE_TYPE_TREE:
375 got_object_tree_close(ce->data.tree);
377 case GOT_OBJECT_CACHE_TYPE_COMMIT:
378 got_object_commit_close(ce->data.commit);
380 case GOT_OBJECT_CACHE_TYPE_TAG:
381 got_object_tag_close(ce->data.tag);
383 case GOT_OBJECT_CACHE_TYPE_RAW:
384 got_object_raw_close(ce->data.raw);
394 got_object_cache_close(struct got_object_cache *cache)
396 #ifdef GOT_OBJ_CACHE_DEBUG
397 switch (cache->type) {
398 case GOT_OBJECT_CACHE_TYPE_OBJ:
399 print_cache_stats(cache, "object");
401 case GOT_OBJECT_CACHE_TYPE_TREE:
402 print_cache_stats(cache, "tree");
404 case GOT_OBJECT_CACHE_TYPE_COMMIT:
405 print_cache_stats(cache, "commit");
407 case GOT_OBJECT_CACHE_TYPE_TAG:
408 print_cache_stats(cache, "tag");
410 case GOT_OBJECT_CACHE_TYPE_RAW:
411 print_cache_stats(cache, "raw");
416 got_object_idset_for_each(cache->idset, check_refcount, cache);
420 got_object_idset_for_each(cache->idset, free_entry, cache);
421 got_object_idset_free(cache->idset);