1 ab2f42e7 2019-11-10 stsp /*
  2 5aa81393 2020-01-06 stsp  * Copyright (c) 2019, 2020 Stefan Sperling <stsp@openbsd.org>
  3 ab2f42e7 2019-11-10 stsp  *
  4 ab2f42e7 2019-11-10 stsp  * Permission to use, copy, modify, and distribute this software for any
  5 ab2f42e7 2019-11-10 stsp  * purpose with or without fee is hereby granted, provided that the above
  6 ab2f42e7 2019-11-10 stsp  * copyright notice and this permission notice appear in all copies.
  7 ab2f42e7 2019-11-10 stsp  *
  8 ab2f42e7 2019-11-10 stsp  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  9 ab2f42e7 2019-11-10 stsp  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 10 ab2f42e7 2019-11-10 stsp  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 11 ab2f42e7 2019-11-10 stsp  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 12 ab2f42e7 2019-11-10 stsp  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 13 ab2f42e7 2019-11-10 stsp  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 14 ab2f42e7 2019-11-10 stsp  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 15 ab2f42e7 2019-11-10 stsp  */
 16 ab2f42e7 2019-11-10 stsp 
 17 ab2f42e7 2019-11-10 stsp #include <sys/queue.h>
 18 ab2f42e7 2019-11-10 stsp 
 19 ab2f42e7 2019-11-10 stsp #include <stdlib.h>
 20 ab2f42e7 2019-11-10 stsp #include <string.h>
 21 ab2f42e7 2019-11-10 stsp #include <sha1.h>
 22 ab2f42e7 2019-11-10 stsp #include <stdio.h>
 23 ab2f42e7 2019-11-10 stsp #include <zlib.h>
 24 ab2f42e7 2019-11-10 stsp #include <limits.h>
 25 ab2f42e7 2019-11-10 stsp #include <time.h>
 26 ab2f42e7 2019-11-10 stsp 
 27 ab2f42e7 2019-11-10 stsp #include "got_object.h"
 28 ab2f42e7 2019-11-10 stsp #include "got_error.h"
 29 ab2f42e7 2019-11-10 stsp 
 30 ab2f42e7 2019-11-10 stsp #include "got_lib_delta.h"
 31 ab2f42e7 2019-11-10 stsp #include "got_lib_inflate.h"
 32 ab2f42e7 2019-11-10 stsp #include "got_lib_object.h"
 33 ab2f42e7 2019-11-10 stsp #include "got_lib_delta_cache.h"
 34 ab2f42e7 2019-11-10 stsp 
 35 ab2f42e7 2019-11-10 stsp #ifndef nitems
 36 ab2f42e7 2019-11-10 stsp #define nitems(_a) (sizeof(_a) / sizeof((_a)[0]))
 37 ab2f42e7 2019-11-10 stsp #endif
 38 ab2f42e7 2019-11-10 stsp 
 39 ab2f42e7 2019-11-10 stsp struct got_delta_cache_element {
 40 ab2f42e7 2019-11-10 stsp 	TAILQ_ENTRY(got_delta_cache_element) entry;
 41 ab2f42e7 2019-11-10 stsp 	off_t delta_data_offset;
 42 ab2f42e7 2019-11-10 stsp 	uint8_t *delta_data;
 43 ab2f42e7 2019-11-10 stsp 	size_t delta_len;
 44 ab2f42e7 2019-11-10 stsp };
 45 ab2f42e7 2019-11-10 stsp 
 46 ab2f42e7 2019-11-10 stsp TAILQ_HEAD(got_delta_cache_head, got_delta_cache_element);
 47 ab2f42e7 2019-11-10 stsp 
 48 ab2f42e7 2019-11-10 stsp struct got_delta_cache {
 49 ab2f42e7 2019-11-10 stsp 	struct got_delta_cache_head entries;
 50 ab2f42e7 2019-11-10 stsp 	int nelem;
 51 ab2f42e7 2019-11-10 stsp 	int maxelem;
 52 ab2f42e7 2019-11-10 stsp 	size_t maxelemsize;
 53 c3b318d0 2019-11-10 stsp 	int cache_search;
 54 c3b318d0 2019-11-10 stsp 	int cache_hit;
 55 c3b318d0 2019-11-10 stsp 	int cache_miss;
 56 c3b318d0 2019-11-10 stsp 	int cache_evict;
 57 c3b318d0 2019-11-10 stsp 	int cache_toolarge;
 58 ab2f42e7 2019-11-10 stsp };
 59 ab2f42e7 2019-11-10 stsp 
 60 ab2f42e7 2019-11-10 stsp struct got_delta_cache *
 61 ab2f42e7 2019-11-10 stsp got_delta_cache_alloc(int maxelem, size_t maxelemsize)
 62 ab2f42e7 2019-11-10 stsp {
 63 ab2f42e7 2019-11-10 stsp 	struct got_delta_cache *cache;
 64 ab2f42e7 2019-11-10 stsp 
 65 ab2f42e7 2019-11-10 stsp 	cache = calloc(1, sizeof(*cache));
 66 ab2f42e7 2019-11-10 stsp 	if (cache == NULL)
 67 ab2f42e7 2019-11-10 stsp 		return NULL;
 68 ab2f42e7 2019-11-10 stsp 
 69 ab2f42e7 2019-11-10 stsp 	TAILQ_INIT(&cache->entries);
 70 ab2f42e7 2019-11-10 stsp 	cache->maxelem = maxelem;
 71 ab2f42e7 2019-11-10 stsp 	cache->maxelemsize = maxelemsize;
 72 ab2f42e7 2019-11-10 stsp 	return cache;
 73 ab2f42e7 2019-11-10 stsp }
 74 ab2f42e7 2019-11-10 stsp 
 75 ab2f42e7 2019-11-10 stsp void
 76 ab2f42e7 2019-11-10 stsp got_delta_cache_free(struct got_delta_cache *cache)
 77 ab2f42e7 2019-11-10 stsp {
 78 ab2f42e7 2019-11-10 stsp 	struct got_delta_cache_element *entry;
 79 ab2f42e7 2019-11-10 stsp 
 80 c3b318d0 2019-11-10 stsp #ifdef GOT_OBJ_CACHE_DEBUG
 81 c3b318d0 2019-11-10 stsp 	fprintf(stderr, "%s: delta cache: %d elements, %d searches, %d hits, "
 82 c3b318d0 2019-11-10 stsp 	    "%d missed, %d evicted, %d too large\n", getprogname(), cache->nelem,
 83 c3b318d0 2019-11-10 stsp 	    cache->cache_search, cache->cache_hit, cache->cache_miss,
 84 c3b318d0 2019-11-10 stsp 	    cache->cache_evict, cache->cache_toolarge);
 85 c3b318d0 2019-11-10 stsp #endif
 86 ab2f42e7 2019-11-10 stsp 	while (!TAILQ_EMPTY(&cache->entries)) {
 87 ab2f42e7 2019-11-10 stsp 		entry = TAILQ_FIRST(&cache->entries);
 88 ab2f42e7 2019-11-10 stsp 		TAILQ_REMOVE(&cache->entries, entry, entry);
 89 ab2f42e7 2019-11-10 stsp 		free(entry->delta_data);
 90 ab2f42e7 2019-11-10 stsp 		free(entry);
 91 ab2f42e7 2019-11-10 stsp 	}
 92 ab2f42e7 2019-11-10 stsp 	free(cache);
 93 ab2f42e7 2019-11-10 stsp }
 94 ab2f42e7 2019-11-10 stsp 
 95 fa7a529e 2020-01-06 stsp #ifndef GOT_NO_OBJ_CACHE
 96 ab2f42e7 2019-11-10 stsp static void
 97 ab2f42e7 2019-11-10 stsp remove_least_used_element(struct got_delta_cache *cache)
 98 ab2f42e7 2019-11-10 stsp {
 99 ab2f42e7 2019-11-10 stsp 	struct got_delta_cache_element *entry;
100 ab2f42e7 2019-11-10 stsp 
101 ab2f42e7 2019-11-10 stsp 	if (cache->nelem == 0)
102 ab2f42e7 2019-11-10 stsp 		return;
103 ab2f42e7 2019-11-10 stsp 
104 ab2f42e7 2019-11-10 stsp 	entry = TAILQ_LAST(&cache->entries, got_delta_cache_head);
105 ab2f42e7 2019-11-10 stsp 	TAILQ_REMOVE(&cache->entries, entry, entry);
106 ab2f42e7 2019-11-10 stsp 	free(entry->delta_data);
107 ab2f42e7 2019-11-10 stsp 	free(entry);
108 ab2f42e7 2019-11-10 stsp 	cache->nelem--;
109 c3b318d0 2019-11-10 stsp 	cache->cache_evict++;
110 ab2f42e7 2019-11-10 stsp }
111 fa7a529e 2020-01-06 stsp #endif
112 ab2f42e7 2019-11-10 stsp 
113 ab2f42e7 2019-11-10 stsp const struct got_error *
114 ab2f42e7 2019-11-10 stsp got_delta_cache_add(struct got_delta_cache *cache,
115 ab2f42e7 2019-11-10 stsp     off_t delta_data_offset, uint8_t *delta_data, size_t delta_len)
116 ab2f42e7 2019-11-10 stsp {
117 fa7a529e 2020-01-06 stsp #ifdef GOT_NO_OBJ_CACHE
118 fa7a529e 2020-01-06 stsp 	return got_error(GOT_ERR_NO_SPACE);
119 fa7a529e 2020-01-06 stsp #else
120 ab2f42e7 2019-11-10 stsp 	struct got_delta_cache_element *entry;
121 ab2f42e7 2019-11-10 stsp 
122 c3b318d0 2019-11-10 stsp 	if (delta_len > cache->maxelemsize) {
123 c3b318d0 2019-11-10 stsp 		cache->cache_toolarge++;
124 ab2f42e7 2019-11-10 stsp 		return got_error(GOT_ERR_NO_SPACE);
125 c3b318d0 2019-11-10 stsp 	}
126 ab2f42e7 2019-11-10 stsp 
127 ab2f42e7 2019-11-10 stsp 	if (cache->nelem >= cache->maxelem)
128 ab2f42e7 2019-11-10 stsp 		remove_least_used_element(cache);
129 ab2f42e7 2019-11-10 stsp 
130 ab2f42e7 2019-11-10 stsp 	entry = calloc(1, sizeof(*entry));
131 ab2f42e7 2019-11-10 stsp 	if (entry == NULL)
132 ab2f42e7 2019-11-10 stsp 		return got_error_from_errno("calloc");
133 ab2f42e7 2019-11-10 stsp 
134 ab2f42e7 2019-11-10 stsp 	entry->delta_data_offset = delta_data_offset;
135 ab2f42e7 2019-11-10 stsp 	entry->delta_data = delta_data;
136 ab2f42e7 2019-11-10 stsp 	entry->delta_len = delta_len;
137 ab2f42e7 2019-11-10 stsp 
138 ab2f42e7 2019-11-10 stsp 	TAILQ_INSERT_HEAD(&cache->entries, entry, entry);
139 ab2f42e7 2019-11-10 stsp 	cache->nelem++;
140 ab2f42e7 2019-11-10 stsp 	return NULL;
141 fa7a529e 2020-01-06 stsp #endif
142 ab2f42e7 2019-11-10 stsp }
143 ab2f42e7 2019-11-10 stsp 
144 ab2f42e7 2019-11-10 stsp void
145 ab2f42e7 2019-11-10 stsp got_delta_cache_get(uint8_t **delta_data, size_t *delta_len,
146 ab2f42e7 2019-11-10 stsp     struct got_delta_cache *cache, off_t delta_data_offset)
147 ab2f42e7 2019-11-10 stsp {
148 ab2f42e7 2019-11-10 stsp 	struct got_delta_cache_element *entry;
149 ab2f42e7 2019-11-10 stsp 
150 c3b318d0 2019-11-10 stsp 	cache->cache_search++;
151 ab2f42e7 2019-11-10 stsp 	*delta_data = NULL;
152 ab2f42e7 2019-11-10 stsp 	*delta_len = 0;
153 ab2f42e7 2019-11-10 stsp 	TAILQ_FOREACH(entry, &cache->entries, entry) {
154 ab2f42e7 2019-11-10 stsp 		if (entry->delta_data_offset != delta_data_offset)
155 ab2f42e7 2019-11-10 stsp 			continue;
156 c3b318d0 2019-11-10 stsp 		cache->cache_hit++;
157 ab2f42e7 2019-11-10 stsp 		if (entry != TAILQ_FIRST(&cache->entries)) {
158 ab2f42e7 2019-11-10 stsp 			TAILQ_REMOVE(&cache->entries, entry, entry);
159 ab2f42e7 2019-11-10 stsp 			TAILQ_INSERT_HEAD(&cache->entries, entry, entry);
160 ab2f42e7 2019-11-10 stsp 		}
161 ab2f42e7 2019-11-10 stsp 		*delta_data = entry->delta_data;
162 ab2f42e7 2019-11-10 stsp 		*delta_len = entry->delta_len;
163 ab2f42e7 2019-11-10 stsp 		return;
164 ab2f42e7 2019-11-10 stsp 	}
165 c3b318d0 2019-11-10 stsp 
166 c3b318d0 2019-11-10 stsp 	cache->cache_miss++;
167 ab2f42e7 2019-11-10 stsp }