Gotweb

Blob

Date:: Sat Oct 16 11:09:49 2021 UTC
Message:: cache raw objects in order to speed up gotadmin pack
Actions:: History | Blame | Raw File
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 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 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 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 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 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, void *item)
149 {
150 	const struct got_error *err = NULL;
151 	struct got_object_cache_entry *ce;
152 	int nelem;
153 	size_t size;
154 
155 	switch (cache->type) {
156 	case GOT_OBJECT_CACHE_TYPE_OBJ:
157 		size = get_size_obj((struct got_object *)item);
158 		break;
159 	case GOT_OBJECT_CACHE_TYPE_TREE:
160 		size = get_size_tree((struct got_tree_object *)item);
161 		break;
162 	case GOT_OBJECT_CACHE_TYPE_COMMIT:
163 		size = get_size_commit((struct got_commit_object *)item);
164 		break;
165 	case GOT_OBJECT_CACHE_TYPE_TAG:
166 		size = get_size_tag((struct got_tag_object *)item);
167 		break;
168 	case GOT_OBJECT_CACHE_TYPE_RAW:
169 		size = get_size_raw((struct got_raw_object *)item);
170 		break;
171 	default:
172 		return got_error(GOT_ERR_OBJ_TYPE);
173 	}
174 
175 	if (size > GOT_OBJECT_CACHE_MAX_ELEM_SIZE) {
176 #ifdef GOT_OBJ_CACHE_DEBUG
177 		char *id_str;
178 		if (got_object_id_str(&id_str, id) != NULL)
179 			return got_error_from_errno("got_object_id_str");
180 		fprintf(stderr, "%s: not caching ", getprogname());
181 		switch (cache->type) {
182 		case GOT_OBJECT_CACHE_TYPE_OBJ:
183 			fprintf(stderr, "object");
184 			break;
185 		case GOT_OBJECT_CACHE_TYPE_TREE:
186 			fprintf(stderr, "tree");
187 			break;
188 		case GOT_OBJECT_CACHE_TYPE_COMMIT:
189 			fprintf(stderr, "commit");
190 			break;
191 		case GOT_OBJECT_CACHE_TYPE_TAG:
192 			fprintf(stderr, "tag");
193 			break;
194 		case GOT_OBJECT_CACHE_TYPE_RAW:
195 			fprintf(stderr, "raw");
196 			break;
197 		}
198 		fprintf(stderr, " %s (%zd bytes; %zd MB)\n", id_str, size,
199 		    size/1024/1024);
200 		free(id_str);
201 #endif
202 		cache->cache_toolarge++;
203 		return got_error(GOT_ERR_OBJ_TOO_LARGE);
204 	}
205 
206 	nelem = got_object_idset_num_elements(cache->idset);
207 	if (nelem >= cache->size) {
208 		err = got_object_idset_remove((void **)&ce,
209 		    cache->idset, NULL);
210 		if (err)
211 			return err;
212 		switch (cache->type) {
213 		case GOT_OBJECT_CACHE_TYPE_OBJ:
214 			got_object_close(ce->data.obj);
215 			break;
216 		case GOT_OBJECT_CACHE_TYPE_TREE:
217 			got_object_tree_close(ce->data.tree);
218 			break;
219 		case GOT_OBJECT_CACHE_TYPE_COMMIT:
220 			got_object_commit_close(ce->data.commit);
221 			break;
222 		case GOT_OBJECT_CACHE_TYPE_TAG:
223 			got_object_tag_close(ce->data.tag);
224 			break;
225 		case GOT_OBJECT_CACHE_TYPE_RAW:
226 			got_object_raw_close(ce->data.raw);
227 			break;
228 		}
229 		free(ce);
230 		cache->cache_evict++;
231 	}
232 
233 	ce = malloc(sizeof(*ce));
234 	if (ce == NULL)
235 		return got_error_from_errno("malloc");
236 	memcpy(&ce->id, id, sizeof(ce->id));
237 	switch (cache->type) {
238 	case GOT_OBJECT_CACHE_TYPE_OBJ:
239 		ce->data.obj = (struct got_object *)item;
240 		break;
241 	case GOT_OBJECT_CACHE_TYPE_TREE:
242 		ce->data.tree = (struct got_tree_object *)item;
243 		break;
244 	case GOT_OBJECT_CACHE_TYPE_COMMIT:
245 		ce->data.commit = (struct got_commit_object *)item;
246 		break;
247 	case GOT_OBJECT_CACHE_TYPE_TAG:
248 		ce->data.tag = (struct got_tag_object *)item;
249 		break;
250 	case GOT_OBJECT_CACHE_TYPE_RAW:
251 		ce->data.raw = (struct got_raw_object *)item;
252 		break;
253 	}
254 
255 	err = got_object_idset_add(cache->idset, id, ce);
256 	if (err)
257 		free(ce);
258 	return err;
259 }
260 
261 void *
262 got_object_cache_get(struct got_object_cache *cache, struct got_object_id *id)
263 {
264 	struct got_object_cache_entry *ce;
265 
266 	cache->cache_searches++;
267 	ce = got_object_idset_get(cache->idset, id);
268 	if (ce) {
269 		cache->cache_hit++;
270 		switch (cache->type) {
271 		case GOT_OBJECT_CACHE_TYPE_OBJ:
272 			return ce->data.obj;
273 		case GOT_OBJECT_CACHE_TYPE_TREE:
274 			return ce->data.tree;
275 		case GOT_OBJECT_CACHE_TYPE_COMMIT:
276 			return ce->data.commit;
277 		case GOT_OBJECT_CACHE_TYPE_TAG:
278 			return ce->data.tag;
279 		case GOT_OBJECT_CACHE_TYPE_RAW:
280 			return ce->data.raw;
281 		}
282 	}
283 
284 	cache->cache_miss++;
285 	return NULL;
286 }
287 
288 #ifdef GOT_OBJ_CACHE_DEBUG
289 static void
290 print_cache_stats(struct got_object_cache *cache, const char *name)
291 {
292 	fprintf(stderr, "%s: %s cache: %d elements, %d searches, %d hits, "
293 	    "%d missed, %d evicted, %d too large\n", getprogname(), name,
294 	    got_object_idset_num_elements(cache->idset),
295 	    cache->cache_searches, cache->cache_hit,
296 	    cache->cache_miss, cache->cache_evict, cache->cache_toolarge);
297 }
298 
299 const struct got_error *
300 check_refcount(struct got_object_id *id, void *data, void *arg)
301 {
302 	struct got_object_cache *cache = arg;
303 	struct got_object_cache_entry *ce = data;
304 	struct got_object *obj;
305 	struct got_tree_object *tree;
306 	struct got_commit_object *commit;
307 	struct got_tag_object *tag;
308 	struct got_raw_object *raw;
309 	char *id_str;
310 
311 	if (got_object_id_str(&id_str, id) != NULL)
312 		return NULL;
313 
314 	switch (cache->type) {
315 	case GOT_OBJECT_CACHE_TYPE_OBJ:
316 		obj = ce->data.obj;
317 		if (obj->refcnt == 1)
318 			break;
319 		fprintf(stderr, "object %s has %d unclaimed references\n",
320 		    id_str, obj->refcnt - 1);
321 		break;
322 	case GOT_OBJECT_CACHE_TYPE_TREE:
323 		tree = ce->data.tree;
324 		if (tree->refcnt == 1)
325 			break;
326 		fprintf(stderr, "tree %s has %d unclaimed references\n",
327 		    id_str, tree->refcnt - 1);
328 		break;
329 	case GOT_OBJECT_CACHE_TYPE_COMMIT:
330 		commit = ce->data.commit;
331 		if (commit->refcnt == 1)
332 			break;
333 		fprintf(stderr, "commit %s has %d unclaimed references\n",
334 		    id_str, commit->refcnt - 1);
335 		break;
336 	case GOT_OBJECT_CACHE_TYPE_TAG:
337 		tag = ce->data.tag;
338 		if (tag->refcnt == 1)
339 			break;
340 		fprintf(stderr, "tag %s has %d unclaimed references\n",
341 		    id_str, tag->refcnt - 1);
342 		break;
343 	case GOT_OBJECT_CACHE_TYPE_RAW:
344 		raw = ce->data.raw;
345 		if (raw->refcnt == 1)
346 			break;
347 		fprintf(stderr, "raw %s has %d unclaimed references\n",
348 		    id_str, raw->refcnt - 1);
349 		break;
350 	}
351 	free(id_str);
352 	return NULL;
353 }
354 #endif
355 
356 void
357 got_object_cache_close(struct got_object_cache *cache)
358 {
359 #ifdef GOT_OBJ_CACHE_DEBUG
360 	switch (cache->type) {
361 	case GOT_OBJECT_CACHE_TYPE_OBJ:
362 		print_cache_stats(cache, "object");
363 		break;
364 	case GOT_OBJECT_CACHE_TYPE_TREE:
365 		print_cache_stats(cache, "tree");
366 		break;
367 	case GOT_OBJECT_CACHE_TYPE_COMMIT:
368 		print_cache_stats(cache, "commit");
369 		break;
370 	case GOT_OBJECT_CACHE_TYPE_TAG:
371 		print_cache_stats(cache, "tag");
372 		break;
373 	case GOT_OBJECT_CACHE_TYPE_RAW:
374 		print_cache_stats(cache, "raw");
375 		break;
376 	}
377 
378 	got_object_idset_for_each(cache->idset, check_refcount, cache);
379 #endif
380 
381 	if (cache->idset) {
382 		got_object_idset_free(cache->idset);
383 		cache->idset = NULL;
384 	}
385 	cache->size = 0;
386 }