]>
Commit | Line | Data |
---|---|---|
bdbb6d04 | 1 | /* |
f70aedc4 | 2 | * Copyright (C) 1996-2021 The Squid Software Foundation and contributors |
e25c139f | 3 | * |
bbc27441 AJ |
4 | * Squid software is distributed under GPLv2+ license and includes |
5 | * contributions from numerous individuals and organizations. | |
6 | * Please see the COPYING and CONTRIBUTORS files for details. | |
bdbb6d04 | 7 | */ |
8 | ||
bbc27441 AJ |
9 | /* DEBUG: section 70 Cache Digest */ |
10 | ||
582c2af2 FC |
11 | #include "squid.h" |
12 | #include "md5.h" | |
e4f1fdae | 13 | #include "StatCounters.h" |
e6ccf245 | 14 | #include "Store.h" |
fb548aaf | 15 | #include "store_key_md5.h" |
bdbb6d04 | 16 | |
c68e9c6b | 17 | #if USE_CACHE_DIGESTS |
18 | ||
b814e8d4 | 19 | #include "CacheDigest.h" |
ed6e9fb9 | 20 | #include "util.h" |
b814e8d4 | 21 | |
12784378 | 22 | /* local types */ |
62e76326 | 23 | |
26ac0430 | 24 | typedef struct { |
f53969cc SM |
25 | int bit_count; /* total number of bits */ |
26 | int bit_on_count; /* #bits turned on */ | |
27 | int bseq_len_sum; /* sum of all bit seq length */ | |
28 | int bseq_count; /* number of bit seqs */ | |
2fadd50d | 29 | } CacheDigestStats; |
12784378 | 30 | |
31 | /* local functions */ | |
13c31e72 | 32 | static void cacheDigestHashKey(const CacheDigest * cd, const cache_key * key); |
bdbb6d04 | 33 | |
34 | /* static array used by cacheDigestHashKey for optimization purposes */ | |
09aabd84 | 35 | static uint32_t hashed_keys[4]; |
bdbb6d04 | 36 | |
afffcaab | 37 | void |
831e953c | 38 | CacheDigest::init(uint64_t newCapacity) |
bdbb6d04 | 39 | { |
afffcaab AJ |
40 | const auto newMaskSz = CacheDigest::CalcMaskSize(newCapacity, bits_per_entry); |
41 | assert(newCapacity > 0 && bits_per_entry > 0); | |
831e953c | 42 | assert(newMaskSz != 0); |
afffcaab AJ |
43 | capacity = newCapacity; |
44 | mask_size = newMaskSz; | |
45 | mask = static_cast<char *>(xcalloc(mask_size,1)); | |
46 | debugs(70, 2, "capacity: " << capacity << " entries, bpe: " << bits_per_entry << "; size: " | |
47 | << mask_size << " bytes"); | |
56a1c446 | 48 | } |
49 | ||
831e953c AJ |
50 | CacheDigest::CacheDigest(uint64_t aCapacity, uint8_t bpe) : |
51 | count(0), | |
52 | del_count(0), | |
53 | capacity(0), | |
895171b1 SM |
54 | mask(nullptr), |
55 | mask_size(0), | |
831e953c | 56 | bits_per_entry(bpe) |
56a1c446 | 57 | { |
f53969cc | 58 | assert(SQUID_MD5_DIGEST_LENGTH == 16); /* our hash functions rely on 16 byte keys */ |
7daad00c | 59 | updateCapacity(aCapacity); |
bdbb6d04 | 60 | } |
61 | ||
a901d0b4 | 62 | CacheDigest::~CacheDigest() |
315127ff | 63 | { |
a901d0b4 | 64 | xfree(mask); |
bdbb6d04 | 65 | } |
66 | ||
6d80b36f | 67 | CacheDigest * |
fab3d38b | 68 | CacheDigest::clone() const |
6d80b36f | 69 | { |
978eaffc AJ |
70 | CacheDigest *cl = new CacheDigest(capacity, bits_per_entry); |
71 | cl->count = count; | |
72 | cl->del_count = del_count; | |
73 | assert(mask_size == cl->mask_size); | |
74 | memcpy(cl->mask, mask, mask_size); | |
75 | return cl; | |
6d80b36f | 76 | } |
77 | ||
12784378 | 78 | void |
28faff32 | 79 | CacheDigest::clear() |
12784378 | 80 | { |
28faff32 AJ |
81 | count = del_count = 0; |
82 | memset(mask, 0, mask_size); | |
12784378 | 83 | } |
84 | ||
304b267e | 85 | void |
831e953c | 86 | CacheDigest::updateCapacity(uint64_t newCapacity) |
304b267e | 87 | { |
7daad00c | 88 | safe_free(mask); |
afffcaab | 89 | init(newCapacity); // will re-init mask and mask_size |
304b267e | 90 | } |
91 | ||
5bc5e81f | 92 | bool |
6fc4e508 | 93 | CacheDigest::contains(const cache_key * key) const |
bdbb6d04 | 94 | { |
5bc5e81f | 95 | assert(key); |
bdbb6d04 | 96 | /* hash */ |
5bc5e81f | 97 | cacheDigestHashKey(this, key); |
bdbb6d04 | 98 | /* test corresponding bits */ |
1afe05c5 | 99 | return |
5bc5e81f AJ |
100 | CBIT_TEST(mask, hashed_keys[0]) && |
101 | CBIT_TEST(mask, hashed_keys[1]) && | |
102 | CBIT_TEST(mask, hashed_keys[2]) && | |
103 | CBIT_TEST(mask, hashed_keys[3]); | |
bdbb6d04 | 104 | } |
105 | ||
c2186446 | 106 | void |
fbba122c | 107 | CacheDigest::add(const cache_key * key) |
c2186446 | 108 | { |
fbba122c | 109 | assert(key); |
c2186446 | 110 | /* hash */ |
fbba122c | 111 | cacheDigestHashKey(this, key); |
c2186446 | 112 | /* turn on corresponding bits */ |
53521734 FC |
113 | int on_xition_cnt = 0; |
114 | ||
115 | if (!CBIT_TEST(mask, hashed_keys[0])) { | |
116 | CBIT_SET(mask, hashed_keys[0]); | |
117 | ++on_xition_cnt; | |
118 | } | |
119 | ||
120 | if (!CBIT_TEST(mask, hashed_keys[1])) { | |
121 | CBIT_SET(mask, hashed_keys[1]); | |
122 | ++on_xition_cnt; | |
123 | } | |
124 | ||
125 | if (!CBIT_TEST(mask, hashed_keys[2])) { | |
126 | CBIT_SET(mask, hashed_keys[2]); | |
127 | ++on_xition_cnt; | |
128 | } | |
129 | ||
130 | if (!CBIT_TEST(mask, hashed_keys[3])) { | |
131 | CBIT_SET(mask, hashed_keys[3]); | |
132 | ++on_xition_cnt; | |
c135694e | 133 | } |
53521734 FC |
134 | |
135 | statCounter.cd.on_xition_count.count(on_xition_cnt); | |
fbba122c | 136 | ++count; |
c2186446 | 137 | } |
138 | ||
bdbb6d04 | 139 | void |
fbba122c | 140 | CacheDigest::remove(const cache_key * key) |
bdbb6d04 | 141 | { |
fbba122c AJ |
142 | assert(key); |
143 | ++del_count; | |
bdbb6d04 | 144 | /* we do not support deletions from the digest */ |
145 | } | |
146 | ||
c2186446 | 147 | /* returns mask utilization parameters */ |
12784378 | 148 | static void |
b644367b | 149 | cacheDigestStats(const CacheDigest * cd, CacheDigestStats * stats) |
c2186446 | 150 | { |
c2186446 | 151 | int on_count = 0; |
56a1c446 | 152 | int pos = cd->mask_size * 8; |
12784378 | 153 | int seq_len_sum = 0; |
154 | int seq_count = 0; | |
155 | int cur_seq_len = 0; | |
156 | int cur_seq_type = 1; | |
157 | assert(stats); | |
158 | memset(stats, 0, sizeof(*stats)); | |
62e76326 | 159 | |
c2186446 | 160 | while (pos-- > 0) { |
62e76326 | 161 | const int is_on = 0 != CBIT_TEST(cd->mask, pos); |
162 | ||
163 | if (is_on) | |
d7ae3534 | 164 | ++on_count; |
62e76326 | 165 | |
166 | if (is_on != cur_seq_type || !pos) { | |
167 | seq_len_sum += cur_seq_len; | |
d7ae3534 | 168 | ++seq_count; |
62e76326 | 169 | cur_seq_type = is_on; |
170 | cur_seq_len = 0; | |
171 | } | |
172 | ||
d7ae3534 | 173 | ++cur_seq_len; |
c2186446 | 174 | } |
62e76326 | 175 | |
56a1c446 | 176 | stats->bit_count = cd->mask_size * 8; |
12784378 | 177 | stats->bit_on_count = on_count; |
178 | stats->bseq_len_sum = seq_len_sum; | |
179 | stats->bseq_count = seq_count; | |
c2186446 | 180 | } |
bdbb6d04 | 181 | |
6fbd1d41 AJ |
182 | double |
183 | CacheDigest::usedMaskPercent() const | |
315127ff | 184 | { |
185 | CacheDigestStats stats; | |
6fbd1d41 AJ |
186 | cacheDigestStats(this, &stats); |
187 | return xpercent(stats.bit_on_count, stats.bit_count); | |
315127ff | 188 | } |
189 | ||
8638fc66 | 190 | void |
e8baef82 | 191 | cacheDigestGuessStatsUpdate(CacheDigestGuessStats * stats, int real_hit, int guess_hit) |
56a1c446 | 192 | { |
193 | assert(stats); | |
62e76326 | 194 | |
56a1c446 | 195 | if (real_hit) { |
62e76326 | 196 | if (guess_hit) |
e8baef82 | 197 | ++stats->trueHits; |
62e76326 | 198 | else |
e8baef82 | 199 | ++stats->falseMisses; |
56a1c446 | 200 | } else { |
62e76326 | 201 | if (guess_hit) |
e8baef82 | 202 | ++stats->falseHits; |
62e76326 | 203 | else |
e8baef82 | 204 | ++stats->trueMisses; |
56a1c446 | 205 | } |
206 | } | |
207 | ||
208 | void | |
0e3b8c9f | 209 | cacheDigestGuessStatsReport(const CacheDigestGuessStats * stats, StoreEntry * sentry, const SBuf &label) |
56a1c446 | 210 | { |
e8baef82 FC |
211 | const int true_count = stats->trueHits + stats->trueMisses; |
212 | const int false_count = stats->falseHits + stats->falseMisses; | |
213 | const int hit_count = stats->trueHits + stats->falseHits; | |
214 | const int miss_count = stats->trueMisses + stats->falseMisses; | |
56a1c446 | 215 | const int tot_count = true_count + false_count; |
4b4cd312 | 216 | |
0e3b8c9f | 217 | assert(!label.isEmpty()); |
f53969cc | 218 | assert(tot_count == hit_count + miss_count); /* paranoid */ |
56a1c446 | 219 | |
e13ee7ad | 220 | if (!tot_count) { |
0e3b8c9f | 221 | storeAppendPrintf(sentry, "no guess stats for " SQUIDSBUFPH " available\n", SQUIDSBUFPRINT(label)); |
62e76326 | 222 | return; |
e13ee7ad | 223 | } |
62e76326 | 224 | |
0e3b8c9f | 225 | storeAppendPrintf(sentry, "Digest guesses stats for " SQUIDSBUFPH ":\n", SQUIDSBUFPRINT(label)); |
56a1c446 | 226 | storeAppendPrintf(sentry, "guess\t hit\t\t miss\t\t total\t\t\n"); |
227 | storeAppendPrintf(sentry, " \t #\t %%\t #\t %%\t #\t %%\t\n"); | |
56a1c446 | 228 | storeAppendPrintf(sentry, "true\t %d\t %.2f\t %d\t %.2f\t %d\t %.2f\n", |
e8baef82 FC |
229 | stats->trueHits, xpercent(stats->trueHits, tot_count), |
230 | stats->trueMisses, xpercent(stats->trueMisses, tot_count), | |
62e76326 | 231 | true_count, xpercent(true_count, tot_count)); |
56a1c446 | 232 | storeAppendPrintf(sentry, "false\t %d\t %.2f\t %d\t %.2f\t %d\t %.2f\n", |
e8baef82 FC |
233 | stats->falseHits, xpercent(stats->falseHits, tot_count), |
234 | stats->falseMisses, xpercent(stats->falseMisses, tot_count), | |
62e76326 | 235 | false_count, xpercent(false_count, tot_count)); |
56a1c446 | 236 | storeAppendPrintf(sentry, "all\t %d\t %.2f\t %d\t %.2f\t %d\t %.2f\n", |
62e76326 | 237 | hit_count, xpercent(hit_count, tot_count), |
238 | miss_count, xpercent(miss_count, tot_count), | |
239 | tot_count, xpercent(tot_count, tot_count)); | |
315127ff | 240 | storeAppendPrintf(sentry, "\tclose_hits: %d ( %d%%) /* cd said hit, doc was in the peer cache, but we got a miss */\n", |
e8baef82 | 241 | stats->closeHits, xpercentInt(stats->closeHits, stats->falseHits)); |
56a1c446 | 242 | } |
243 | ||
244 | void | |
0e3b8c9f | 245 | cacheDigestReport(CacheDigest * cd, const SBuf &label, StoreEntry * e) |
8638fc66 | 246 | { |
12784378 | 247 | CacheDigestStats stats; |
8638fc66 | 248 | assert(cd && e); |
12784378 | 249 | cacheDigestStats(cd, &stats); |
0e3b8c9f AJ |
250 | storeAppendPrintf(e, SQUIDSBUFPH " digest: size: %d bytes\n", |
251 | SQUIDSBUFPRINT(label), stats.bit_count / 8 | |
62e76326 | 252 | ); |
831e953c | 253 | storeAppendPrintf(e, "\t entries: count: %" PRIu64 " capacity: %" PRIu64 " util: %d%%\n", |
62e76326 | 254 | cd->count, |
255 | cd->capacity, | |
256 | xpercentInt(cd->count, cd->capacity) | |
257 | ); | |
831e953c | 258 | storeAppendPrintf(e, "\t deletion attempts: %" PRIu64 "\n", |
62e76326 | 259 | cd->del_count |
260 | ); | |
315127ff | 261 | storeAppendPrintf(e, "\t bits: per entry: %d on: %d capacity: %d util: %d%%\n", |
62e76326 | 262 | cd->bits_per_entry, |
263 | stats.bit_on_count, stats.bit_count, | |
264 | xpercentInt(stats.bit_on_count, stats.bit_count) | |
265 | ); | |
b644367b | 266 | storeAppendPrintf(e, "\t bit-seq: count: %d avg.len: %.2f\n", |
62e76326 | 267 | stats.bseq_count, |
268 | xdiv(stats.bseq_len_sum, stats.bseq_count) | |
269 | ); | |
8638fc66 | 270 | } |
271 | ||
831e953c AJ |
272 | uint32_t |
273 | CacheDigest::CalcMaskSize(uint64_t cap, uint8_t bpe) | |
304b267e | 274 | { |
831e953c | 275 | uint64_t bitCount = (cap * bpe) + 7; |
61beade2 | 276 | assert(bitCount < INT_MAX); // do not 31-bit overflow later |
831e953c | 277 | return static_cast<uint32_t>(bitCount / 8); |
304b267e | 278 | } |
279 | ||
e5834061 | 280 | static void |
5999b776 | 281 | cacheDigestHashKey(const CacheDigest * cd, const cache_key * key) |
e5834061 | 282 | { |
831e953c | 283 | const uint32_t bit_count = cd->mask_size * 8; |
13c31e72 | 284 | unsigned int tmp_keys[4]; |
285 | /* we must memcpy to ensure alignment */ | |
41d00cd3 | 286 | memcpy(tmp_keys, key, sizeof(tmp_keys)); |
e5834061 | 287 | hashed_keys[0] = htonl(tmp_keys[0]) % bit_count; |
288 | hashed_keys[1] = htonl(tmp_keys[1]) % bit_count; | |
289 | hashed_keys[2] = htonl(tmp_keys[2]) % bit_count; | |
290 | hashed_keys[3] = htonl(tmp_keys[3]) % bit_count; | |
bf8fe701 | 291 | debugs(70, 9, "cacheDigestHashKey: " << storeKeyText(key) << " -(" << |
292 | bit_count << ")-> " << hashed_keys[0] << " " << hashed_keys[1] << | |
293 | " " << hashed_keys[2] << " " << hashed_keys[3]); | |
e5834061 | 294 | } |
c68e9c6b | 295 | |
296 | #endif | |
f53969cc | 297 |