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 
20 #include <stdio.h>
21 #include <stdlib.h>
22 #include <stdint.h>
23 #include <string.h>
24 #include <sha1.h>
25 #include <zlib.h>
26 
27 #include "got_error.h"
28 #include "got_object.h"
29 
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"
35 
36 /*
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.
39  */
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 */
45 
46 const struct got_error *
47 got_object_cache_init(struct got_object_cache *cache,
48     enum got_object_cache_type type)
49 {
50 	memset(cache, 0, sizeof(*cache));
51 
52 	cache->idset = got_object_idset_alloc();
53 	if (cache->idset == NULL)
54 		return got_error_from_errno("got_object_idset_alloc");
55 
56 	cache->type = type;
57 	switch (type) {
58 	case GOT_OBJECT_CACHE_TYPE_OBJ:
59 		cache->size = GOT_OBJECT_CACHE_SIZE_OBJ;
60 		break;
61 	case GOT_OBJECT_CACHE_TYPE_TREE:
62 		cache->size = GOT_OBJECT_CACHE_SIZE_TREE;
63 		break;
64 	case GOT_OBJECT_CACHE_TYPE_COMMIT:
65 		cache->size = GOT_OBJECT_CACHE_SIZE_COMMIT;
66 		break;
67 	case GOT_OBJECT_CACHE_TYPE_TAG:
68 		cache->size = GOT_OBJECT_CACHE_SIZE_TAG;
69 		break;
70 	}
71 	return NULL;
72 }
73 
74 size_t
75 get_size_obj(struct got_object *obj)
76 {
77 	size_t size = sizeof(*obj);
78 	struct got_delta *delta;
79 
80 	if (obj->flags & GOT_OBJ_FLAG_PACKED)
81 		size += strlen(obj->path_packfile);
82 
83 	if ((obj->flags & GOT_OBJ_FLAG_DELTIFIED) == 0)
84 		return size;
85 
86 	SIMPLEQ_FOREACH(delta, &obj->deltas.entries, entry) {
87 		if (SIZE_MAX - sizeof(*delta) < size)
88 			return SIZE_MAX;
89 		size += sizeof(*delta);
90 	}
91 
92 	return size;
93 }
94 
95 size_t
96 get_size_tree(struct got_tree_object *tree)
97 {
98 	size_t size = sizeof(*tree);
99 	struct got_tree_entry *te;
100 
101 	SIMPLEQ_FOREACH(te, &tree->entries.head, entry) {
102 		size += sizeof(*te);
103 		size += strlen(te->name);
104 		size += sizeof(*te->id);
105 	}
106 
107 	return size;
108 }
109 
110 size_t
111 get_size_commit(struct got_commit_object *commit)
112 {
113 	size_t size = sizeof(*commit);
114 	struct got_object_qid *qid;
115 
116 	size += sizeof(*commit->tree_id);
117 	size += strlen(commit->author);
118 	size += strlen(commit->committer);
119 	size += strlen(commit->logmsg);
120 
121 	SIMPLEQ_FOREACH(qid, &commit->parent_ids, entry)
122 		size += sizeof(*qid) + sizeof(*qid->id);
123 
124 	return size;
125 }
126 
127 size_t
128 get_size_tag(struct got_tag_object *tag)
129 {
130 	size_t size = sizeof(*tag);
131 
132 	size += strlen(tag->tag);
133 	size += strlen(tag->tagger);
134 	size += strlen(tag->tagmsg);
135 
136 	return size;
137 }
138 
139 const struct got_error *
140 got_object_cache_add(struct got_object_cache *cache, struct got_object_id *id, void *item)
141 {
142 	const struct got_error *err = NULL;
143 	struct got_object_cache_entry *ce;
144 	int nelem;
145 	size_t size;
146 
147 	switch (cache->type) {
148 	case GOT_OBJECT_CACHE_TYPE_OBJ:
149 		size = get_size_obj((struct got_object *)item);
150 		break;
151 	case GOT_OBJECT_CACHE_TYPE_TREE:
152 		size = get_size_tree((struct got_tree_object *)item);
153 		break;
154 	case GOT_OBJECT_CACHE_TYPE_COMMIT:
155 		size = get_size_commit((struct got_commit_object *)item);
156 		break;
157 	case GOT_OBJECT_CACHE_TYPE_TAG:
158 		size = get_size_tag((struct got_tag_object *)item);
159 		break;
160 	default:
161 		return got_error(GOT_ERR_OBJ_TYPE);
162 	}
163 
164 	if (size > GOT_OBJECT_CACHE_MAX_ELEM_SIZE) {
165 #ifdef GOT_OBJ_CACHE_DEBUG
166 		char *id_str;
167 		if (got_object_id_str(&id_str, id) != NULL)
168 			return got_error_from_errno("got_object_id_str");
169 		fprintf(stderr, "%s: not caching ", getprogname());
170 		switch (cache->type) {
171 		case GOT_OBJECT_CACHE_TYPE_OBJ:
172 			fprintf(stderr, "object");
173 			break;
174 		case GOT_OBJECT_CACHE_TYPE_TREE:
175 			fprintf(stderr, "tree");
176 			break;
177 		case GOT_OBJECT_CACHE_TYPE_COMMIT:
178 			fprintf(stderr, "commit");
179 			break;
180 		case GOT_OBJECT_CACHE_TYPE_TAG:
181 			fprintf(stderr, "tag");
182 			break;
183 		}
184 		fprintf(stderr, " %s (%zd bytes; %zd MB)\n", id_str, size,
185 		    size/1024/1024);
186 		free(id_str);
187 #endif
188 		cache->cache_toolarge++;
189 		return got_error(GOT_ERR_OBJ_TOO_LARGE);
190 	}
191 
192 	nelem = got_object_idset_num_elements(cache->idset);
193 	if (nelem >= cache->size) {
194 		err = got_object_idset_remove((void **)&ce,
195 		    cache->idset, NULL);
196 		if (err)
197 			return err;
198 		switch (cache->type) {
199 		case GOT_OBJECT_CACHE_TYPE_OBJ:
200 			got_object_close(ce->data.obj);
201 			break;
202 		case GOT_OBJECT_CACHE_TYPE_TREE:
203 			got_object_tree_close(ce->data.tree);
204 			break;
205 		case GOT_OBJECT_CACHE_TYPE_COMMIT:
206 			got_object_commit_close(ce->data.commit);
207 			break;
208 		case GOT_OBJECT_CACHE_TYPE_TAG:
209 			got_object_tag_close(ce->data.tag);
210 			break;
211 		}
212 		free(ce);
213 		cache->cache_evict++;
214 	}
215 
216 	ce = malloc(sizeof(*ce));
217 	if (ce == NULL)
218 		return got_error_from_errno("malloc");
219 	memcpy(&ce->id, id, sizeof(ce->id));
220 	switch (cache->type) {
221 	case GOT_OBJECT_CACHE_TYPE_OBJ:
222 		ce->data.obj = (struct got_object *)item;
223 		break;
224 	case GOT_OBJECT_CACHE_TYPE_TREE:
225 		ce->data.tree = (struct got_tree_object *)item;
226 		break;
227 	case GOT_OBJECT_CACHE_TYPE_COMMIT:
228 		ce->data.commit = (struct got_commit_object *)item;
229 		break;
230 	case GOT_OBJECT_CACHE_TYPE_TAG:
231 		ce->data.tag = (struct got_tag_object *)item;
232 		break;
233 	}
234 
235 	err = got_object_idset_add(cache->idset, id, ce);
236 	if (err)
237 		free(ce);
238 	return err;
239 }
240 
241 void *
242 got_object_cache_get(struct got_object_cache *cache, struct got_object_id *id)
243 {
244 	struct got_object_cache_entry *ce;
245 
246 	cache->cache_searches++;
247 	ce = got_object_idset_get(cache->idset, id);
248 	if (ce) {
249 		cache->cache_hit++;
250 		switch (cache->type) {
251 		case GOT_OBJECT_CACHE_TYPE_OBJ:
252 			return ce->data.obj;
253 		case GOT_OBJECT_CACHE_TYPE_TREE:
254 			return ce->data.tree;
255 		case GOT_OBJECT_CACHE_TYPE_COMMIT:
256 			return ce->data.commit;
257 		case GOT_OBJECT_CACHE_TYPE_TAG:
258 			return ce->data.tag;
259 		}
260 	}
261 
262 	cache->cache_miss++;
263 	return NULL;
264 }
265 
266 #ifdef GOT_OBJ_CACHE_DEBUG
267 static void
268 print_cache_stats(struct got_object_cache *cache, const char *name)
269 {
270 	fprintf(stderr, "%s: %s cache: %d elements, %d searches, %d hits, "
271 	    "%d missed, %d evicted, %d too large\n", getprogname(), name,
272 	    got_object_idset_num_elements(cache->idset),
273 	    cache->cache_searches, cache->cache_hit,
274 	    cache->cache_miss, cache->cache_evict, cache->cache_toolarge);
275 }
276 
277 const struct got_error *
278 check_refcount(struct got_object_id *id, void *data, void *arg)
279 {
280 	struct got_object_cache *cache = arg;
281 	struct got_object_cache_entry *ce = data;
282 	struct got_object *obj;
283 	struct got_tree_object *tree;
284 	struct got_commit_object *commit;
285 	struct got_tag_object *tag;
286 	char *id_str;
287 
288 	if (got_object_id_str(&id_str, id) != NULL)
289 		return NULL;
290 
291 	switch (cache->type) {
292 	case GOT_OBJECT_CACHE_TYPE_OBJ:
293 		obj = ce->data.obj;
294 		if (obj->refcnt == 1)
295 			break;
296 		fprintf(stderr, "object %s has %d unclaimed references\n",
297 		    id_str, obj->refcnt - 1);
298 		break;
299 	case GOT_OBJECT_CACHE_TYPE_TREE:
300 		tree = ce->data.tree;
301 		if (tree->refcnt == 1)
302 			break;
303 		fprintf(stderr, "tree %s has %d unclaimed references\n",
304 		    id_str, tree->refcnt - 1);
305 		break;
306 	case GOT_OBJECT_CACHE_TYPE_COMMIT:
307 		commit = ce->data.commit;
308 		if (commit->refcnt == 1)
309 			break;
310 		fprintf(stderr, "commit %s has %d unclaimed references\n",
311 		    id_str, commit->refcnt - 1);
312 		break;
313 	case GOT_OBJECT_CACHE_TYPE_TAG:
314 		tag = ce->data.tag;
315 		if (tag->refcnt == 1)
316 			break;
317 		fprintf(stderr, "tag %s has %d unclaimed references\n",
318 		    id_str, tag->refcnt - 1);
319 		break;
320 	}
321 	free(id_str);
322 	return NULL;
323 }
324 #endif
325 
326 void
327 got_object_cache_close(struct got_object_cache *cache)
328 {
329 #ifdef GOT_OBJ_CACHE_DEBUG
330 	switch (cache->type) {
331 	case GOT_OBJECT_CACHE_TYPE_OBJ:
332 		print_cache_stats(cache, "object");
333 		break;
334 	case GOT_OBJECT_CACHE_TYPE_TREE:
335 		print_cache_stats(cache, "tree");
336 		break;
337 	case GOT_OBJECT_CACHE_TYPE_COMMIT:
338 		print_cache_stats(cache, "commit");
339 		break;
340 	case GOT_OBJECT_CACHE_TYPE_TAG:
341 		print_cache_stats(cache, "tag");
342 		break;
343 	}
344 
345 	got_object_idset_for_each(cache->idset, check_refcount, cache);
346 #endif
347 
348 	if (cache->idset) {
349 		got_object_idset_free(cache->idset);
350 		cache->idset = NULL;
351 	}
352 	cache->size = 0;
353 }