1 /*
2  * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
3  *
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.
7  *
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.
15  */
16 
17 #include <sys/time.h>
18 #include <sys/queue.h>
19 #include <sys/resource.h>
20 
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <stdint.h>
24 #include <string.h>
25 #include <limits.h>
26 #include <zlib.h>
27 
28 #include "got_error.h"
29 #include "got_object.h"
30 
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"
36 
37 /*
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.
40  */
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 */
47 
48 const struct got_error *
49 got_object_cache_init(struct got_object_cache *cache,
50     enum got_object_cache_type type)
51 {
52 	struct rlimit rl;
53 
54 	memset(cache, 0, sizeof(*cache));
55 
56 	cache->idset = got_object_idset_alloc();
57 	if (cache->idset == NULL)
58 		return got_error_from_errno("got_object_idset_alloc");
59 
60 	cache->type = type;
61 	switch (type) {
62 	case GOT_OBJECT_CACHE_TYPE_OBJ:
63 		cache->size = GOT_OBJECT_CACHE_SIZE_OBJ;
64 		break;
65 	case GOT_OBJECT_CACHE_TYPE_TREE:
66 		cache->size = GOT_OBJECT_CACHE_SIZE_TREE;
67 		break;
68 	case GOT_OBJECT_CACHE_TYPE_COMMIT:
69 		cache->size = GOT_OBJECT_CACHE_SIZE_COMMIT;
70 		break;
71 	case GOT_OBJECT_CACHE_TYPE_TAG:
72 		cache->size = GOT_OBJECT_CACHE_SIZE_TAG;
73 		break;
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;
80 		break;
81 	}
82 	return NULL;
83 }
84 
85 static size_t
86 get_size_obj(struct got_object *obj)
87 {
88 	size_t size = sizeof(*obj);
89 	struct got_delta *delta;
90 
91 	if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0)
92 		return size;
93 
94 	STAILQ_FOREACH(delta, &obj->deltas.entries, entry) {
95 		if (SIZE_MAX - sizeof(*delta) < size)
96 			return SIZE_MAX;
97 		size += sizeof(*delta);
98 	}
99 
100 	return size;
101 }
102 
103 static size_t
104 get_size_tree(struct got_tree_object *tree)
105 {
106 	size_t size = sizeof(*tree);
107 
108 	size += sizeof(struct got_tree_entry) * tree->nentries;
109 	return size;
110 }
111 
112 static size_t
113 get_size_commit(struct got_commit_object *commit)
114 {
115 	size_t size = sizeof(*commit);
116 	struct got_object_qid *qid;
117 
118 	size += sizeof(*commit->tree_id);
119 	size += strlen(commit->author);
120 	size += strlen(commit->committer);
121 	size += strlen(commit->logmsg);
122 
123 	STAILQ_FOREACH(qid, &commit->parent_ids, entry)
124 		size += sizeof(*qid) + sizeof(qid->id);
125 
126 	return size;
127 }
128 
129 static size_t
130 get_size_tag(struct got_tag_object *tag)
131 {
132 	size_t size = sizeof(*tag);
133 
134 	size += strlen(tag->tag);
135 	size += strlen(tag->tagger);
136 	size += strlen(tag->tagmsg);
137 
138 	return size;
139 }
140 
141 static size_t
142 get_size_raw(struct got_raw_object *raw)
143 {
144 	return sizeof(*raw);
145 }
146 
147 const struct got_error *
148 got_object_cache_add(struct got_object_cache *cache, struct got_object_id *id,
149     void *item)
150 {
151 	const struct got_error *err = NULL;
152 	struct got_object_cache_entry *ce;
153 	int nelem;
154 	size_t size;
155 
156 	switch (cache->type) {
157 	case GOT_OBJECT_CACHE_TYPE_OBJ:
158 		size = get_size_obj((struct got_object *)item);
159 		break;
160 	case GOT_OBJECT_CACHE_TYPE_TREE:
161 		size = get_size_tree((struct got_tree_object *)item);
162 		break;
163 	case GOT_OBJECT_CACHE_TYPE_COMMIT:
164 		size = get_size_commit((struct got_commit_object *)item);
165 		break;
166 	case GOT_OBJECT_CACHE_TYPE_TAG:
167 		size = get_size_tag((struct got_tag_object *)item);
168 		break;
169 	case GOT_OBJECT_CACHE_TYPE_RAW:
170 		size = get_size_raw((struct got_raw_object *)item);
171 		break;
172 	default:
173 		return got_error(GOT_ERR_OBJ_TYPE);
174 	}
175 
176 	if (size > GOT_OBJECT_CACHE_MAX_ELEM_SIZE) {
177 #ifdef GOT_OBJ_CACHE_DEBUG
178 		char *id_str;
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");
185 			break;
186 		case GOT_OBJECT_CACHE_TYPE_TREE:
187 			fprintf(stderr, "tree");
188 			break;
189 		case GOT_OBJECT_CACHE_TYPE_COMMIT:
190 			fprintf(stderr, "commit");
191 			break;
192 		case GOT_OBJECT_CACHE_TYPE_TAG:
193 			fprintf(stderr, "tag");
194 			break;
195 		case GOT_OBJECT_CACHE_TYPE_RAW:
196 			fprintf(stderr, "raw");
197 			break;
198 		}
199 		fprintf(stderr, " %s (%zd bytes; %zd MB)\n", id_str, size,
200 		    size/1024/1024);
201 		free(id_str);
202 #endif
203 		cache->cache_toolarge++;
204 		return got_error(GOT_ERR_OBJ_TOO_LARGE);
205 	}
206 
207 	nelem = got_object_idset_num_elements(cache->idset);
208 	if (nelem >= cache->size) {
209 		err = got_object_idset_remove((void **)&ce,
210 		    cache->idset, NULL);
211 		if (err)
212 			return err;
213 		switch (cache->type) {
214 		case GOT_OBJECT_CACHE_TYPE_OBJ:
215 			got_object_close(ce->data.obj);
216 			break;
217 		case GOT_OBJECT_CACHE_TYPE_TREE:
218 			got_object_tree_close(ce->data.tree);
219 			break;
220 		case GOT_OBJECT_CACHE_TYPE_COMMIT:
221 			got_object_commit_close(ce->data.commit);
222 			break;
223 		case GOT_OBJECT_CACHE_TYPE_TAG:
224 			got_object_tag_close(ce->data.tag);
225 			break;
226 		case GOT_OBJECT_CACHE_TYPE_RAW:
227 			got_object_raw_close(ce->data.raw);
228 			break;
229 		}
230 		memset(ce, 0, sizeof(*ce));
231 		cache->cache_evict++;
232 	} else {
233 		ce = malloc(sizeof(*ce));
234 		if (ce == NULL)
235 			return got_error_from_errno("malloc");
236 	}
237 
238 	memcpy(&ce->id, id, sizeof(ce->id));
239 	switch (cache->type) {
240 	case GOT_OBJECT_CACHE_TYPE_OBJ:
241 		ce->data.obj = (struct got_object *)item;
242 		break;
243 	case GOT_OBJECT_CACHE_TYPE_TREE:
244 		ce->data.tree = (struct got_tree_object *)item;
245 		break;
246 	case GOT_OBJECT_CACHE_TYPE_COMMIT:
247 		ce->data.commit = (struct got_commit_object *)item;
248 		break;
249 	case GOT_OBJECT_CACHE_TYPE_TAG:
250 		ce->data.tag = (struct got_tag_object *)item;
251 		break;
252 	case GOT_OBJECT_CACHE_TYPE_RAW:
253 		ce->data.raw = (struct got_raw_object *)item;
254 		break;
255 	}
256 
257 	err = got_object_idset_add(cache->idset, id, ce);
258 	if (err)
259 		free(ce);
260 	else if (size > cache->max_cached_size)
261 		cache->max_cached_size = size;
262 	return err;
263 }
264 
265 void *
266 got_object_cache_get(struct got_object_cache *cache, struct got_object_id *id)
267 {
268 	struct got_object_cache_entry *ce;
269 
270 	cache->cache_searches++;
271 	ce = got_object_idset_get(cache->idset, id);
272 	if (ce) {
273 		cache->cache_hit++;
274 		switch (cache->type) {
275 		case GOT_OBJECT_CACHE_TYPE_OBJ:
276 			return ce->data.obj;
277 		case GOT_OBJECT_CACHE_TYPE_TREE:
278 			return ce->data.tree;
279 		case GOT_OBJECT_CACHE_TYPE_COMMIT:
280 			return ce->data.commit;
281 		case GOT_OBJECT_CACHE_TYPE_TAG:
282 			return ce->data.tag;
283 		case GOT_OBJECT_CACHE_TYPE_RAW:
284 			return ce->data.raw;
285 		}
286 	}
287 
288 	cache->cache_miss++;
289 	return NULL;
290 }
291 
292 #ifdef GOT_OBJ_CACHE_DEBUG
293 static void
294 print_cache_stats(struct got_object_cache *cache, const char *name)
295 {
296 	fprintf(stderr, "%s: %s cache: %d elements, %d searches, %d hits, "
297 	    "%d missed, %d evicted, %d too large, max cached %zd bytes\n",
298 	    getprogname(), name,
299 	    cache->idset ? got_object_idset_num_elements(cache->idset) : -1,
300 	    cache->cache_searches, cache->cache_hit,
301 	    cache->cache_miss, cache->cache_evict, cache->cache_toolarge,
302 	    cache->max_cached_size);
303 }
304 
305 static const struct got_error *
306 check_refcount(struct got_object_id *id, void *data, void *arg)
307 {
308 	struct got_object_cache *cache = arg;
309 	struct got_object_cache_entry *ce = data;
310 	struct got_object *obj;
311 	struct got_tree_object *tree;
312 	struct got_commit_object *commit;
313 	struct got_tag_object *tag;
314 	struct got_raw_object *raw;
315 	char *id_str;
316 
317 	if (got_object_id_str(&id_str, id) != NULL)
318 		return NULL;
319 
320 	switch (cache->type) {
321 	case GOT_OBJECT_CACHE_TYPE_OBJ:
322 		obj = ce->data.obj;
323 		if (obj->refcnt == 1)
324 			break;
325 		fprintf(stderr, "object %s has %d unclaimed references\n",
326 		    id_str, obj->refcnt - 1);
327 		break;
328 	case GOT_OBJECT_CACHE_TYPE_TREE:
329 		tree = ce->data.tree;
330 		if (tree->refcnt == 1)
331 			break;
332 		fprintf(stderr, "tree %s has %d unclaimed references\n",
333 		    id_str, tree->refcnt - 1);
334 		break;
335 	case GOT_OBJECT_CACHE_TYPE_COMMIT:
336 		commit = ce->data.commit;
337 		if (commit->refcnt == 1)
338 			break;
339 		fprintf(stderr, "commit %s has %d unclaimed references\n",
340 		    id_str, commit->refcnt - 1);
341 		break;
342 	case GOT_OBJECT_CACHE_TYPE_TAG:
343 		tag = ce->data.tag;
344 		if (tag->refcnt == 1)
345 			break;
346 		fprintf(stderr, "tag %s has %d unclaimed references\n",
347 		    id_str, tag->refcnt - 1);
348 		break;
349 	case GOT_OBJECT_CACHE_TYPE_RAW:
350 		raw = ce->data.raw;
351 		if (raw->refcnt == 1)
352 			break;
353 		fprintf(stderr, "raw %s has %d unclaimed references\n",
354 		    id_str, raw->refcnt - 1);
355 		break;
356 	}
357 	free(id_str);
358 	return NULL;
359 }
360 #endif
361 
362 static const struct got_error *
363 free_entry(struct got_object_id *id, void *data, void *arg)
364 {
365 	struct got_object_cache *cache = arg;
366 	struct got_object_cache_entry *ce = data;
367 
368 	switch (cache->type) {
369 	case GOT_OBJECT_CACHE_TYPE_OBJ:
370 		got_object_close(ce->data.obj);
371 		break;
372 	case GOT_OBJECT_CACHE_TYPE_TREE:
373 		got_object_tree_close(ce->data.tree);
374 		break;
375 	case GOT_OBJECT_CACHE_TYPE_COMMIT:
376 		got_object_commit_close(ce->data.commit);
377 		break;
378 	case GOT_OBJECT_CACHE_TYPE_TAG:
379 		got_object_tag_close(ce->data.tag);
380 		break;
381 	case GOT_OBJECT_CACHE_TYPE_RAW:
382 		got_object_raw_close(ce->data.raw);
383 		break;
384 	}
385 
386 	free(ce);
387 
388 	return NULL;
389 }
390 
391 void
392 got_object_cache_close(struct got_object_cache *cache)
393 {
394 #ifdef GOT_OBJ_CACHE_DEBUG
395 	switch (cache->type) {
396 	case GOT_OBJECT_CACHE_TYPE_OBJ:
397 		print_cache_stats(cache, "object");
398 		break;
399 	case GOT_OBJECT_CACHE_TYPE_TREE:
400 		print_cache_stats(cache, "tree");
401 		break;
402 	case GOT_OBJECT_CACHE_TYPE_COMMIT:
403 		print_cache_stats(cache, "commit");
404 		break;
405 	case GOT_OBJECT_CACHE_TYPE_TAG:
406 		print_cache_stats(cache, "tag");
407 		break;
408 	case GOT_OBJECT_CACHE_TYPE_RAW:
409 		print_cache_stats(cache, "raw");
410 		break;
411 	}
412 
413 	if (cache->idset)
414 		got_object_idset_for_each(cache->idset, check_refcount, cache);
415 #endif
416 
417 	if (cache->idset) {
418 		got_object_idset_for_each(cache->idset, free_entry, cache);
419 		got_object_idset_free(cache->idset);
420 		cache->idset = NULL;
421 	}
422 	cache->size = 0;
423 }