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>
27 #include "got_error.h"
28 #include "got_object.h"
30 #include "got_lib_delta.h"
31 #include "got_lib_inflate.h"
32 #include "got_lib_object.h"
33 #include "got_lib_object_idset.h"
34 #include "got_lib_object_cache.h"
37 * XXX This should be reworked to track cache size and usage in bytes,
38 * rather than tracking N elements capped to a maximum element size.
40 #define GOT_OBJECT_CACHE_SIZE_OBJ 256
41 #define GOT_OBJECT_CACHE_SIZE_TREE 256
42 #define GOT_OBJECT_CACHE_SIZE_COMMIT 64
43 #define GOT_OBJECT_CACHE_SIZE_TAG 32
44 #define GOT_OBJECT_CACHE_MAX_ELEM_SIZE 1048576 /* 1 MB */
46 const struct got_error *
47 got_object_cache_init(struct got_object_cache *cache,
48 enum got_object_cache_type type)
50 memset(cache, 0, sizeof(*cache));
52 cache->idset = got_object_idset_alloc();
53 if (cache->idset == NULL)
54 return got_error_from_errno("got_object_idset_alloc");
58 case GOT_OBJECT_CACHE_TYPE_OBJ:
59 cache->size = GOT_OBJECT_CACHE_SIZE_OBJ;
61 case GOT_OBJECT_CACHE_TYPE_TREE:
62 cache->size = GOT_OBJECT_CACHE_SIZE_TREE;
64 case GOT_OBJECT_CACHE_TYPE_COMMIT:
65 cache->size = GOT_OBJECT_CACHE_SIZE_COMMIT;
67 case GOT_OBJECT_CACHE_TYPE_TAG:
68 cache->size = GOT_OBJECT_CACHE_SIZE_TAG;
75 get_size_obj(struct got_object *obj)
77 size_t size = sizeof(*obj);
78 struct got_delta *delta;
80 if (obj->flags & GOT_OBJ_FLAG_PACKED)
81 size += strlen(obj->path_packfile);
83 if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0)
86 SIMPLEQ_FOREACH(delta, &obj->deltas.entries, entry) {
87 if (SIZE_MAX - (sizeof(*delta) + delta->delta_len) < size)
89 size += sizeof(*delta) + delta->delta_len;
96 get_size_tree(struct got_tree_object *tree)
98 size_t size = sizeof(*tree);
99 struct got_tree_entry *te;
101 SIMPLEQ_FOREACH(te, &tree->entries.head, entry) {
103 size += strlen(te->name);
104 size += sizeof(*te->id);
111 get_size_commit(struct got_commit_object *commit)
113 size_t size = sizeof(*commit);
114 struct got_object_qid *qid;
116 size += sizeof(*commit->tree_id);
117 size += strlen(commit->author);
118 size += strlen(commit->committer);
119 size += strlen(commit->logmsg);
121 SIMPLEQ_FOREACH(qid, &commit->parent_ids, entry)
122 size += sizeof(*qid) + sizeof(*qid->id);
128 get_size_tag(struct got_tag_object *tag)
130 size_t size = sizeof(*tag);
132 size += strlen(tag->tag);
133 size += strlen(tag->tagger);
134 size += strlen(tag->tagmsg);
139 const struct got_error *
140 got_object_cache_add(struct got_object_cache *cache, struct got_object_id *id, void *item)
142 const struct got_error *err = NULL;
143 struct got_object_cache_entry *ce;
147 switch (cache->type) {
148 case GOT_OBJECT_CACHE_TYPE_OBJ:
149 size = get_size_obj((struct got_object *)item);
151 case GOT_OBJECT_CACHE_TYPE_TREE:
152 size = get_size_tree((struct got_tree_object *)item);
154 case GOT_OBJECT_CACHE_TYPE_COMMIT:
155 size = get_size_commit((struct got_commit_object *)item);
157 case GOT_OBJECT_CACHE_TYPE_TAG:
158 size = get_size_tag((struct got_tag_object *)item);
162 if (size > GOT_OBJECT_CACHE_MAX_ELEM_SIZE) {
163 #ifdef GOT_OBJ_CACHE_DEBUG
165 if (got_object_id_str(&id_str, id) != NULL)
166 return got_error_from_errno("got_object_id_str");
167 fprintf(stderr, "%s: not caching ", getprogname());
168 switch (cache->type) {
169 case GOT_OBJECT_CACHE_TYPE_OBJ:
170 fprintf(stderr, "object");
172 case GOT_OBJECT_CACHE_TYPE_TREE:
173 fprintf(stderr, "tree");
175 case GOT_OBJECT_CACHE_TYPE_COMMIT:
176 fprintf(stderr, "commit");
178 case GOT_OBJECT_CACHE_TYPE_TAG:
179 fprintf(stderr, "tag");
182 fprintf(stderr, " %s (%zd bytes; %zd MB)\n", id_str, size,
186 cache->cache_toolarge++;
190 nelem = got_object_idset_num_elements(cache->idset);
191 if (nelem >= cache->size) {
192 err = got_object_idset_remove((void **)&ce,
196 switch (cache->type) {
197 case GOT_OBJECT_CACHE_TYPE_OBJ:
198 got_object_close(ce->data.obj);
200 case GOT_OBJECT_CACHE_TYPE_TREE:
201 got_object_tree_close(ce->data.tree);
203 case GOT_OBJECT_CACHE_TYPE_COMMIT:
204 got_object_commit_close(ce->data.commit);
206 case GOT_OBJECT_CACHE_TYPE_TAG:
207 got_object_tag_close(ce->data.tag);
211 cache->cache_evict++;
214 ce = malloc(sizeof(*ce));
216 return got_error_from_errno("malloc");
217 memcpy(&ce->id, id, sizeof(ce->id));
218 switch (cache->type) {
219 case GOT_OBJECT_CACHE_TYPE_OBJ:
220 ce->data.obj = (struct got_object *)item;
222 case GOT_OBJECT_CACHE_TYPE_TREE:
223 ce->data.tree = (struct got_tree_object *)item;
225 case GOT_OBJECT_CACHE_TYPE_COMMIT:
226 ce->data.commit = (struct got_commit_object *)item;
228 case GOT_OBJECT_CACHE_TYPE_TAG:
229 ce->data.tag = (struct got_tag_object *)item;
233 err = got_object_idset_add(cache->idset, id, ce);
235 if (err->code == GOT_ERR_OBJ_EXISTS) {
244 got_object_cache_get(struct got_object_cache *cache, struct got_object_id *id)
246 struct got_object_cache_entry *ce;
248 cache->cache_searches++;
249 ce = got_object_idset_get(cache->idset, id);
252 switch (cache->type) {
253 case GOT_OBJECT_CACHE_TYPE_OBJ:
255 case GOT_OBJECT_CACHE_TYPE_TREE:
256 return ce->data.tree;
257 case GOT_OBJECT_CACHE_TYPE_COMMIT:
258 return ce->data.commit;
259 case GOT_OBJECT_CACHE_TYPE_TAG:
268 #ifdef GOT_OBJ_CACHE_DEBUG
270 print_cache_stats(struct got_object_cache *cache, const char *name)
272 fprintf(stderr, "%s: %s cache: %d elements, %d searches, %d hits, "
273 "%d missed, %d evicted, %d too large\n", getprogname(), name,
274 got_object_idset_num_elements(cache->idset),
275 cache->cache_searches, cache->cache_hit,
276 cache->cache_miss, cache->cache_evict, cache->cache_toolarge);
279 const struct got_error *
280 check_refcount(struct got_object_id *id, void *data, void *arg)
282 struct got_object_cache *cache = arg;
283 struct got_object_cache_entry *ce = data;
284 struct got_object *obj;
285 struct got_tree_object *tree;
286 struct got_commit_object *commit;
287 struct got_tag_object *tag;
290 if (got_object_id_str(&id_str, id) != NULL)
293 switch (cache->type) {
294 case GOT_OBJECT_CACHE_TYPE_OBJ:
296 if (obj->refcnt == 1)
298 fprintf(stderr, "object %s has %d unclaimed references\n",
299 id_str, obj->refcnt - 1);
301 case GOT_OBJECT_CACHE_TYPE_TREE:
302 tree = ce->data.tree;
303 if (tree->refcnt == 1)
305 fprintf(stderr, "tree %s has %d unclaimed references\n",
306 id_str, tree->refcnt - 1);
308 case GOT_OBJECT_CACHE_TYPE_COMMIT:
309 commit = ce->data.commit;
310 if (commit->refcnt == 1)
312 fprintf(stderr, "commit %s has %d unclaimed references\n",
313 id_str, commit->refcnt - 1);
315 case GOT_OBJECT_CACHE_TYPE_TAG:
317 if (tag->refcnt == 1)
319 fprintf(stderr, "tag %s has %d unclaimed references\n",
320 id_str, tag->refcnt - 1);
329 got_object_cache_close(struct got_object_cache *cache)
331 #ifdef GOT_OBJ_CACHE_DEBUG
332 switch (cache->type) {
333 case GOT_OBJECT_CACHE_TYPE_OBJ:
334 print_cache_stats(cache, "object");
336 case GOT_OBJECT_CACHE_TYPE_TREE:
337 print_cache_stats(cache, "tree");
339 case GOT_OBJECT_CACHE_TYPE_COMMIT:
340 print_cache_stats(cache, "commit");
342 case GOT_OBJECT_CACHE_TYPE_TAG:
343 print_cache_stats(cache, "tag");
347 got_object_idset_for_each(cache->idset, check_refcount, cache);
351 got_object_idset_free(cache->idset);