2 Trivial Database 2: human-readable summary code
3 Copyright (C) Rusty Russell 2010
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 3 of the License, or (at your option) any later version.
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with this library; if not, see <http://www.gnu.org/licenses/>.
20 #include <ccan/tally/tally.h>
22 static int count_hash(struct tdb_context *tdb,
23 tdb_off_t hash_off, unsigned bits)
26 unsigned int i, count = 0;
28 h = tdb_access_read(tdb, hash_off, sizeof(*h) << bits, true);
31 for (i = 0; i < (1 << bits); i++)
34 tdb_access_release(tdb, h);
38 static bool summarize(struct tdb_context *tdb,
46 struct tally *buckets)
52 for (off = sizeof(struct tdb_header); off < tdb->map_size; off += len) {
54 struct tdb_used_record u;
55 struct tdb_free_record f;
56 struct tdb_recovery_record r;
58 /* We might not be able to get the whole thing. */
59 p = tdb_get(tdb, off, &pad, sizeof(p->f));
62 if (p->r.magic == TDB_RECOVERY_INVALID_MAGIC
63 || p->r.magic == TDB_RECOVERY_MAGIC) {
64 len = sizeof(p->r) + p->r.max_len;
65 } else if (rec_magic(&p->u) != TDB_MAGIC) {
68 tally_add(buckets, size_to_bucket(len));
71 } else if (frec_magic(&p->f) == TDB_FREE_MAGIC) {
73 tally_add(uncoal, unc);
77 + rec_key_length(&p->u)
78 + rec_data_length(&p->u)
79 + rec_extra_padding(&p->u);
81 /* FIXME: Use different magic for hashes, flists. */
82 if (!rec_key_length(&p->u) && rec_hash(&p->u) < 2) {
83 if (rec_hash(&p->u) == 0) {
84 int count = count_hash(tdb,
86 TDB_SUBLEVEL_HASH_BITS);
89 tally_add(hashes, count);
92 rec_data_length(&p->u));
95 tally_add(keys, rec_key_length(&p->u));
96 tally_add(data, rec_data_length(&p->u));
98 tally_add(extra, rec_extra_padding(&p->u));
100 len = dead_space(tdb, off);
103 tally_add(uncoal, unc);
107 #define SUMMARY_FORMAT \
108 "Size of file/data: %zu/%zu\n" \
109 "Number of records: %zu\n" \
110 "Smallest/average/largest keys: %zu/%zu/%zu\n%s" \
111 "Smallest/average/largest data: %zu/%zu/%zu\n%s" \
112 "Smallest/average/largest padding: %zu/%zu/%zu\n%s" \
113 "Number of free records: %zu\n" \
114 "Smallest/average/largest free records: %zu/%zu/%zu\n%s" \
115 "Number of uncoalesced records: %zu\n" \
116 "Smallest/average/largest uncoalesced runs: %zu/%zu/%zu\n%s" \
117 "Number of free lists: %zu\n%s" \
118 "Toplevel hash used: %u of %u\n" \
119 "Number of subhashes: %zu\n" \
120 "Smallest/average/largest subhash entries: %zu/%zu/%zu\n%s" \
121 "Percentage keys/data/padding/free/rechdrs/freehdrs/hashes: %.0f/%.0f/%.0f/%.0f/%.0f/%.0f/%.0f\n"
123 #define BUCKET_SUMMARY_FORMAT_A \
124 "Free bucket %zu: total entries %zu.\n" \
125 "Smallest/average/largest length: %zu/%zu/%zu\n%s"
126 #define BUCKET_SUMMARY_FORMAT_B \
127 "Free bucket %zu-%zu: total entries %zu.\n" \
128 "Smallest/average/largest length: %zu/%zu/%zu\n%s"
130 #define HISTO_WIDTH 70
131 #define HISTO_HEIGHT 20
133 char *tdb_summary(struct tdb_context *tdb, enum tdb_summary_flags flags)
136 struct tally *flists, *hashes, *freet, *keys, *data, *extra, *uncoal,
138 char *hashesg, *freeg, *keysg, *datag, *extrag, *uncoalg, *bucketsg;
141 hashesg = freeg = keysg = datag = extrag = uncoalg = bucketsg = NULL;
143 if (tdb_allrecord_lock(tdb, F_RDLCK, TDB_LOCK_WAIT, false) != 0)
146 if (tdb_lock_expand(tdb, F_RDLCK) != 0) {
147 tdb_allrecord_unlock(tdb, F_RDLCK);
151 /* Start stats off empty. */
152 flists = tally_new(HISTO_HEIGHT);
153 hashes = tally_new(HISTO_HEIGHT);
154 freet = tally_new(HISTO_HEIGHT);
155 keys = tally_new(HISTO_HEIGHT);
156 data = tally_new(HISTO_HEIGHT);
157 extra = tally_new(HISTO_HEIGHT);
158 uncoal = tally_new(HISTO_HEIGHT);
159 buckets = tally_new(HISTO_HEIGHT);
160 if (!flists || !hashes || !freet || !keys || !data || !extra
161 || !uncoal || !buckets) {
162 tdb->ecode = TDB_ERR_OOM;
166 if (!summarize(tdb, hashes, flists, freet, keys, data, extra, uncoal,
170 if (flags & TDB_SUMMARY_HISTOGRAMS) {
171 hashesg = tally_histogram(hashes, HISTO_WIDTH, HISTO_HEIGHT);
172 freeg = tally_histogram(freet, HISTO_WIDTH, HISTO_HEIGHT);
173 keysg = tally_histogram(keys, HISTO_WIDTH, HISTO_HEIGHT);
174 datag = tally_histogram(data, HISTO_WIDTH, HISTO_HEIGHT);
175 extrag = tally_histogram(extra, HISTO_WIDTH, HISTO_HEIGHT);
176 uncoalg = tally_histogram(uncoal, HISTO_WIDTH, HISTO_HEIGHT);
177 bucketsg = tally_histogram(buckets, HISTO_WIDTH, HISTO_HEIGHT);
180 /* 20 is max length of a %llu. */
181 len = strlen(SUMMARY_FORMAT) + 33*20 + 1
182 + (hashesg ? strlen(hashesg) : 0)
183 + (freeg ? strlen(freeg) : 0)
184 + (keysg ? strlen(keysg) : 0)
185 + (datag ? strlen(datag) : 0)
186 + (extrag ? strlen(extrag) : 0)
187 + (uncoalg ? strlen(uncoalg) : 0)
188 + (bucketsg ? strlen(bucketsg) : 0);
194 len = sprintf(ret, SUMMARY_FORMAT,
195 (size_t)tdb->map_size,
196 tally_num(keys) + tally_num(data),
198 tally_min(keys), tally_mean(keys), tally_max(keys),
200 tally_min(data), tally_mean(data), tally_max(data),
202 tally_min(extra), tally_mean(extra), tally_max(extra),
203 extrag ? extrag : "",
205 tally_min(freet), tally_mean(freet), tally_max(freet),
207 tally_total(uncoal, NULL),
208 tally_min(uncoal), tally_mean(uncoal), tally_max(uncoal),
209 uncoalg ? uncoalg : "",
211 bucketsg ? bucketsg : "",
212 count_hash(tdb, offsetof(struct tdb_header, hashtable),
213 TDB_TOPLEVEL_HASH_BITS),
214 1 << TDB_TOPLEVEL_HASH_BITS,
216 tally_min(hashes), tally_mean(hashes), tally_max(hashes),
217 hashesg ? hashesg : "",
218 tally_total(keys, NULL) * 100.0 / tdb->map_size,
219 tally_total(data, NULL) * 100.0 / tdb->map_size,
220 tally_total(extra, NULL) * 100.0 / tdb->map_size,
221 tally_total(freet, NULL) * 100.0 / tdb->map_size,
222 (tally_num(keys) + tally_num(freet) + tally_num(hashes))
223 * sizeof(struct tdb_used_record) * 100.0 / tdb->map_size,
224 tally_num(flists) * sizeof(struct tdb_freelist)
225 * 100.0 / tdb->map_size,
227 * (sizeof(tdb_off_t) << TDB_SUBLEVEL_HASH_BITS)
228 + (sizeof(tdb_off_t) << TDB_TOPLEVEL_HASH_BITS))
229 * 100.0 / tdb->map_size);
247 tdb_allrecord_unlock(tdb, F_RDLCK);
248 tdb_unlock_expand(tdb, F_RDLCK);