2 6bef87be 2018-09-11 stsp * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
4 6bef87be 2018-09-11 stsp * Permission to use, copy, modify, and distribute this software for any
5 6bef87be 2018-09-11 stsp * purpose with or without fee is hereby granted, provided that the above
6 6bef87be 2018-09-11 stsp * copyright notice and this permission notice appear in all copies.
8 6bef87be 2018-09-11 stsp * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 6bef87be 2018-09-11 stsp * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 6bef87be 2018-09-11 stsp * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 6bef87be 2018-09-11 stsp * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 6bef87be 2018-09-11 stsp * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 6bef87be 2018-09-11 stsp * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 6bef87be 2018-09-11 stsp * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 6bef87be 2018-09-11 stsp #include <sys/time.h>
18 6bef87be 2018-09-11 stsp #include <sys/queue.h>
20 6bef87be 2018-09-11 stsp #include <stdio.h>
21 6bef87be 2018-09-11 stsp #include <stdlib.h>
22 a60c9e77 2019-05-22 stsp #include <stdint.h>
23 6bef87be 2018-09-11 stsp #include <string.h>
24 56e0773d 2019-11-28 stsp #include <limits.h>
25 6bef87be 2018-09-11 stsp #include <sha1.h>
26 6bef87be 2018-09-11 stsp #include <zlib.h>
28 6bef87be 2018-09-11 stsp #include "got_error.h"
29 6bef87be 2018-09-11 stsp #include "got_object.h"
31 6bef87be 2018-09-11 stsp #include "got_lib_delta.h"
32 6bef87be 2018-09-11 stsp #include "got_lib_inflate.h"
33 6bef87be 2018-09-11 stsp #include "got_lib_object.h"
34 f054b67a 2018-11-05 stsp #include "got_lib_object_idset.h"
35 6bef87be 2018-09-11 stsp #include "got_lib_object_cache.h"
38 a60c9e77 2019-05-22 stsp * XXX This should be reworked to track cache size and usage in bytes,
39 a60c9e77 2019-05-22 stsp * rather than tracking N elements capped to a maximum element size.
41 9bccfa63 2018-11-05 stsp #define GOT_OBJECT_CACHE_SIZE_OBJ 256
42 9185b863 2018-11-05 stsp #define GOT_OBJECT_CACHE_SIZE_TREE 256
43 9bccfa63 2018-11-05 stsp #define GOT_OBJECT_CACHE_SIZE_COMMIT 64
44 f73df793 2020-01-07 stsp #define GOT_OBJECT_CACHE_SIZE_TAG 2048
45 a60c9e77 2019-05-22 stsp #define GOT_OBJECT_CACHE_MAX_ELEM_SIZE 1048576 /* 1 MB */
47 6bef87be 2018-09-11 stsp const struct got_error *
48 6bef87be 2018-09-11 stsp got_object_cache_init(struct got_object_cache *cache,
49 6bef87be 2018-09-11 stsp enum got_object_cache_type type)
51 dab9d9b6 2018-11-05 stsp memset(cache, 0, sizeof(*cache));
53 f054b67a 2018-11-05 stsp cache->idset = got_object_idset_alloc();
54 f054b67a 2018-11-05 stsp if (cache->idset == NULL)
55 638f9024 2019-05-13 stsp return got_error_from_errno("got_object_idset_alloc");
57 f054b67a 2018-11-05 stsp cache->type = type;
58 6bef87be 2018-09-11 stsp switch (type) {
59 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_OBJ:
60 f054b67a 2018-11-05 stsp cache->size = GOT_OBJECT_CACHE_SIZE_OBJ;
62 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_TREE:
63 f054b67a 2018-11-05 stsp cache->size = GOT_OBJECT_CACHE_SIZE_TREE;
65 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_COMMIT:
66 f054b67a 2018-11-05 stsp cache->size = GOT_OBJECT_CACHE_SIZE_COMMIT;
68 f4a881ce 2018-11-17 stsp case GOT_OBJECT_CACHE_TYPE_TAG:
69 f4a881ce 2018-11-17 stsp cache->size = GOT_OBJECT_CACHE_SIZE_TAG;
72 6bef87be 2018-09-11 stsp return NULL;
76 a60c9e77 2019-05-22 stsp get_size_obj(struct got_object *obj)
78 a60c9e77 2019-05-22 stsp size_t size = sizeof(*obj);
79 a60c9e77 2019-05-22 stsp struct got_delta *delta;
81 a60c9e77 2019-05-22 stsp if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0)
82 a60c9e77 2019-05-22 stsp return size;
84 a60c9e77 2019-05-22 stsp SIMPLEQ_FOREACH(delta, &obj->deltas.entries, entry) {
85 42c69117 2019-11-10 stsp if (SIZE_MAX - sizeof(*delta) < size)
86 a60c9e77 2019-05-22 stsp return SIZE_MAX;
87 42c69117 2019-11-10 stsp size += sizeof(*delta);
90 a60c9e77 2019-05-22 stsp return size;
94 a60c9e77 2019-05-22 stsp get_size_tree(struct got_tree_object *tree)
96 a60c9e77 2019-05-22 stsp size_t size = sizeof(*tree);
98 56e0773d 2019-11-28 stsp size += sizeof(struct got_tree_entry) * tree->nentries;
99 a60c9e77 2019-05-22 stsp return size;
103 a60c9e77 2019-05-22 stsp get_size_commit(struct got_commit_object *commit)
105 a60c9e77 2019-05-22 stsp size_t size = sizeof(*commit);
106 a60c9e77 2019-05-22 stsp struct got_object_qid *qid;
108 a60c9e77 2019-05-22 stsp size += sizeof(*commit->tree_id);
109 a60c9e77 2019-05-22 stsp size += strlen(commit->author);
110 a60c9e77 2019-05-22 stsp size += strlen(commit->committer);
111 a60c9e77 2019-05-22 stsp size += strlen(commit->logmsg);
113 a60c9e77 2019-05-22 stsp SIMPLEQ_FOREACH(qid, &commit->parent_ids, entry)
114 a60c9e77 2019-05-22 stsp size += sizeof(*qid) + sizeof(*qid->id);
116 a60c9e77 2019-05-22 stsp return size;
120 a60c9e77 2019-05-22 stsp get_size_tag(struct got_tag_object *tag)
122 a60c9e77 2019-05-22 stsp size_t size = sizeof(*tag);
124 a60c9e77 2019-05-22 stsp size += strlen(tag->tag);
125 a60c9e77 2019-05-22 stsp size += strlen(tag->tagger);
126 a60c9e77 2019-05-22 stsp size += strlen(tag->tagmsg);
128 a60c9e77 2019-05-22 stsp return size;
131 6bef87be 2018-09-11 stsp const struct got_error *
132 6bef87be 2018-09-11 stsp got_object_cache_add(struct got_object_cache *cache, struct got_object_id *id, void *item)
134 6bef87be 2018-09-11 stsp const struct got_error *err = NULL;
135 6bef87be 2018-09-11 stsp struct got_object_cache_entry *ce;
137 a60c9e77 2019-05-22 stsp size_t size;
139 a60c9e77 2019-05-22 stsp switch (cache->type) {
140 a60c9e77 2019-05-22 stsp case GOT_OBJECT_CACHE_TYPE_OBJ:
141 a60c9e77 2019-05-22 stsp size = get_size_obj((struct got_object *)item);
143 a60c9e77 2019-05-22 stsp case GOT_OBJECT_CACHE_TYPE_TREE:
144 a60c9e77 2019-05-22 stsp size = get_size_tree((struct got_tree_object *)item);
146 a60c9e77 2019-05-22 stsp case GOT_OBJECT_CACHE_TYPE_COMMIT:
147 a60c9e77 2019-05-22 stsp size = get_size_commit((struct got_commit_object *)item);
149 a60c9e77 2019-05-22 stsp case GOT_OBJECT_CACHE_TYPE_TAG:
150 a60c9e77 2019-05-22 stsp size = get_size_tag((struct got_tag_object *)item);
153 a0de39f3 2019-08-09 stsp return got_error(GOT_ERR_OBJ_TYPE);
156 01cd7614 2019-05-22 stsp if (size > GOT_OBJECT_CACHE_MAX_ELEM_SIZE) {
157 01cd7614 2019-05-22 stsp #ifdef GOT_OBJ_CACHE_DEBUG
158 01cd7614 2019-05-22 stsp char *id_str;
159 01cd7614 2019-05-22 stsp if (got_object_id_str(&id_str, id) != NULL)
160 01cd7614 2019-05-22 stsp return got_error_from_errno("got_object_id_str");
161 01cd7614 2019-05-22 stsp fprintf(stderr, "%s: not caching ", getprogname());
162 01cd7614 2019-05-22 stsp switch (cache->type) {
163 01cd7614 2019-05-22 stsp case GOT_OBJECT_CACHE_TYPE_OBJ:
164 01cd7614 2019-05-22 stsp fprintf(stderr, "object");
166 01cd7614 2019-05-22 stsp case GOT_OBJECT_CACHE_TYPE_TREE:
167 01cd7614 2019-05-22 stsp fprintf(stderr, "tree");
169 01cd7614 2019-05-22 stsp case GOT_OBJECT_CACHE_TYPE_COMMIT:
170 01cd7614 2019-05-22 stsp fprintf(stderr, "commit");
172 01cd7614 2019-05-22 stsp case GOT_OBJECT_CACHE_TYPE_TAG:
173 01cd7614 2019-05-22 stsp fprintf(stderr, "tag");
176 01cd7614 2019-05-22 stsp fprintf(stderr, " %s (%zd bytes; %zd MB)\n", id_str, size,
177 01cd7614 2019-05-22 stsp size/1024/1024);
178 01cd7614 2019-05-22 stsp free(id_str);
180 01cd7614 2019-05-22 stsp cache->cache_toolarge++;
181 79c99a64 2019-05-23 stsp return got_error(GOT_ERR_OBJ_TOO_LARGE);
184 f054b67a 2018-11-05 stsp nelem = got_object_idset_num_elements(cache->idset);
185 6bef87be 2018-09-11 stsp if (nelem >= cache->size) {
186 f054b67a 2018-11-05 stsp err = got_object_idset_remove((void **)&ce,
187 f054b67a 2018-11-05 stsp cache->idset, NULL);
189 6bef87be 2018-09-11 stsp return err;
190 6bef87be 2018-09-11 stsp switch (cache->type) {
191 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_OBJ:
192 6bef87be 2018-09-11 stsp got_object_close(ce->data.obj);
194 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_TREE:
195 6bef87be 2018-09-11 stsp got_object_tree_close(ce->data.tree);
197 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_COMMIT:
198 6bef87be 2018-09-11 stsp got_object_commit_close(ce->data.commit);
200 f4a881ce 2018-11-17 stsp case GOT_OBJECT_CACHE_TYPE_TAG:
201 f4a881ce 2018-11-17 stsp got_object_tag_close(ce->data.tag);
205 315fa2b2 2018-09-15 stsp cache->cache_evict++;
208 507aef8f 2018-11-05 stsp ce = malloc(sizeof(*ce));
209 6bef87be 2018-09-11 stsp if (ce == NULL)
210 638f9024 2019-05-13 stsp return got_error_from_errno("malloc");
211 6bef87be 2018-09-11 stsp memcpy(&ce->id, id, sizeof(ce->id));
212 6bef87be 2018-09-11 stsp switch (cache->type) {
213 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_OBJ:
214 6bef87be 2018-09-11 stsp ce->data.obj = (struct got_object *)item;
216 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_TREE:
217 6bef87be 2018-09-11 stsp ce->data.tree = (struct got_tree_object *)item;
219 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_COMMIT:
220 6bef87be 2018-09-11 stsp ce->data.commit = (struct got_commit_object *)item;
222 f4a881ce 2018-11-17 stsp case GOT_OBJECT_CACHE_TYPE_TAG:
223 f4a881ce 2018-11-17 stsp ce->data.tag = (struct got_tag_object *)item;
227 f054b67a 2018-11-05 stsp err = got_object_idset_add(cache->idset, id, ce);
230 6bef87be 2018-09-11 stsp return err;
234 6bef87be 2018-09-11 stsp got_object_cache_get(struct got_object_cache *cache, struct got_object_id *id)
236 6bef87be 2018-09-11 stsp struct got_object_cache_entry *ce;
238 221e79cd 2018-09-16 stsp cache->cache_searches++;
239 f054b67a 2018-11-05 stsp ce = got_object_idset_get(cache->idset, id);
241 6bef87be 2018-09-11 stsp cache->cache_hit++;
242 6bef87be 2018-09-11 stsp switch (cache->type) {
243 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_OBJ:
244 6bef87be 2018-09-11 stsp return ce->data.obj;
245 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_TREE:
246 6bef87be 2018-09-11 stsp return ce->data.tree;
247 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_COMMIT:
248 6bef87be 2018-09-11 stsp return ce->data.commit;
249 f4a881ce 2018-11-17 stsp case GOT_OBJECT_CACHE_TYPE_TAG:
250 f4a881ce 2018-11-17 stsp return ce->data.tag;
254 6bef87be 2018-09-11 stsp cache->cache_miss++;
255 6bef87be 2018-09-11 stsp return NULL;
258 f4081577 2018-09-15 stsp #ifdef GOT_OBJ_CACHE_DEBUG
259 6bef87be 2018-09-11 stsp static void
260 6bef87be 2018-09-11 stsp print_cache_stats(struct got_object_cache *cache, const char *name)
262 221e79cd 2018-09-16 stsp fprintf(stderr, "%s: %s cache: %d elements, %d searches, %d hits, "
263 01cd7614 2019-05-22 stsp "%d missed, %d evicted, %d too large\n", getprogname(), name,
264 f054b67a 2018-11-05 stsp got_object_idset_num_elements(cache->idset),
265 221e79cd 2018-09-16 stsp cache->cache_searches, cache->cache_hit,
266 01cd7614 2019-05-22 stsp cache->cache_miss, cache->cache_evict, cache->cache_toolarge);
269 cb103d04 2018-11-07 stsp const struct got_error *
270 cb103d04 2018-11-07 stsp check_refcount(struct got_object_id *id, void *data, void *arg)
272 6bef87be 2018-09-11 stsp struct got_object_cache *cache = arg;
273 6bef87be 2018-09-11 stsp struct got_object_cache_entry *ce = data;
274 6bef87be 2018-09-11 stsp struct got_object *obj;
275 6bef87be 2018-09-11 stsp struct got_tree_object *tree;
276 6bef87be 2018-09-11 stsp struct got_commit_object *commit;
277 f4a881ce 2018-11-17 stsp struct got_tag_object *tag;
278 6bef87be 2018-09-11 stsp char *id_str;
280 6bef87be 2018-09-11 stsp if (got_object_id_str(&id_str, id) != NULL)
281 cb103d04 2018-11-07 stsp return NULL;
283 6bef87be 2018-09-11 stsp switch (cache->type) {
284 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_OBJ:
285 6bef87be 2018-09-11 stsp obj = ce->data.obj;
286 6bef87be 2018-09-11 stsp if (obj->refcnt == 1)
288 6bef87be 2018-09-11 stsp fprintf(stderr, "object %s has %d unclaimed references\n",
289 6bef87be 2018-09-11 stsp id_str, obj->refcnt - 1);
291 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_TREE:
292 6bef87be 2018-09-11 stsp tree = ce->data.tree;
293 6bef87be 2018-09-11 stsp if (tree->refcnt == 1)
295 6bef87be 2018-09-11 stsp fprintf(stderr, "tree %s has %d unclaimed references\n",
296 6bef87be 2018-09-11 stsp id_str, tree->refcnt - 1);
298 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_COMMIT:
299 6bef87be 2018-09-11 stsp commit = ce->data.commit;
300 6bef87be 2018-09-11 stsp if (commit->refcnt == 1)
302 6bef87be 2018-09-11 stsp fprintf(stderr, "commit %s has %d unclaimed references\n",
303 414611d9 2018-09-19 stsp id_str, commit->refcnt - 1);
305 f4a881ce 2018-11-17 stsp case GOT_OBJECT_CACHE_TYPE_TAG:
306 f4a881ce 2018-11-17 stsp tag = ce->data.tag;
307 f4a881ce 2018-11-17 stsp if (tag->refcnt == 1)
309 f4a881ce 2018-11-17 stsp fprintf(stderr, "tag %s has %d unclaimed references\n",
310 f4a881ce 2018-11-17 stsp id_str, tag->refcnt - 1);
313 6bef87be 2018-09-11 stsp free(id_str);
314 cb103d04 2018-11-07 stsp return NULL;
319 6bef87be 2018-09-11 stsp got_object_cache_close(struct got_object_cache *cache)
321 f4081577 2018-09-15 stsp #ifdef GOT_OBJ_CACHE_DEBUG
322 6bef87be 2018-09-11 stsp switch (cache->type) {
323 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_OBJ:
324 6bef87be 2018-09-11 stsp print_cache_stats(cache, "object");
326 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_TREE:
327 6bef87be 2018-09-11 stsp print_cache_stats(cache, "tree");
329 6bef87be 2018-09-11 stsp case GOT_OBJECT_CACHE_TYPE_COMMIT:
330 6bef87be 2018-09-11 stsp print_cache_stats(cache, "commit");
332 2ee32b23 2019-05-15 stsp case GOT_OBJECT_CACHE_TYPE_TAG:
333 2ee32b23 2019-05-15 stsp print_cache_stats(cache, "tag");
337 f054b67a 2018-11-05 stsp got_object_idset_for_each(cache->idset, check_refcount, cache);
340 f054b67a 2018-11-05 stsp if (cache->idset) {
341 f054b67a 2018-11-05 stsp got_object_idset_free(cache->idset);
342 f054b67a 2018-11-05 stsp cache->idset = NULL;
344 6bef87be 2018-09-11 stsp cache->size = 0;