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,
40 struct tally *ftables,
46 struct tally *buckets,
53 for (off = sizeof(struct tdb_header); off < tdb->map_size; off += len) {
55 struct tdb_used_record u;
56 struct tdb_free_record f;
57 struct tdb_recovery_record r;
59 /* We might not be able to get the whole thing. */
60 p = tdb_access_read(tdb, off, sizeof(p->f), true);
63 if (p->r.magic == TDB_RECOVERY_INVALID_MAGIC
64 || p->r.magic == TDB_RECOVERY_MAGIC) {
66 tally_add(uncoal, unc);
69 len = sizeof(p->r) + p->r.max_len;
70 } else if (frec_magic(&p->f) == TDB_FREE_MAGIC) {
71 len = frec_len(&p->f);
73 tally_add(buckets, size_to_bucket(len));
76 } else if (rec_magic(&p->u) == TDB_USED_MAGIC) {
78 tally_add(uncoal, unc);
82 + rec_key_length(&p->u)
83 + rec_data_length(&p->u)
84 + rec_extra_padding(&p->u);
86 tally_add(keys, rec_key_length(&p->u));
87 tally_add(data, rec_data_length(&p->u));
88 tally_add(extra, rec_extra_padding(&p->u));
89 } else if (rec_magic(&p->u) == TDB_HTABLE_MAGIC) {
90 int count = count_hash(tdb,
92 TDB_SUBLEVEL_HASH_BITS);
95 tally_add(hashes, count);
96 tally_add(extra, rec_extra_padding(&p->u));
98 + rec_data_length(&p->u)
99 + rec_extra_padding(&p->u);
100 } else if (rec_magic(&p->u) == TDB_FTABLE_MAGIC) {
102 + rec_data_length(&p->u)
103 + rec_extra_padding(&p->u);
104 tally_add(ftables, rec_data_length(&p->u));
105 tally_add(extra, rec_extra_padding(&p->u));
106 } else if (rec_magic(&p->u) == TDB_CHAIN_MAGIC) {
108 + rec_data_length(&p->u)
109 + rec_extra_padding(&p->u);
110 tally_add(chains, 1);
111 tally_add(extra, rec_extra_padding(&p->u));
113 len = dead_space(tdb, off);
114 tdb_access_release(tdb, p);
117 tally_add(uncoal, unc);
121 #define SUMMARY_FORMAT \
122 "Size of file/data: %zu/%zu\n" \
123 "Number of records: %zu\n" \
124 "Smallest/average/largest keys: %zu/%zu/%zu\n%s" \
125 "Smallest/average/largest data: %zu/%zu/%zu\n%s" \
126 "Smallest/average/largest padding: %zu/%zu/%zu\n%s" \
127 "Number of free records: %zu\n" \
128 "Smallest/average/largest free records: %zu/%zu/%zu\n%s" \
129 "Number of uncoalesced records: %zu\n" \
130 "Smallest/average/largest uncoalesced runs: %zu/%zu/%zu\n%s" \
131 "Number of free lists: %zu\n%s" \
132 "Toplevel hash used: %u of %u\n" \
133 "Number of chains: %zu\n" \
134 "Number of subhashes: %zu\n" \
135 "Smallest/average/largest subhash entries: %zu/%zu/%zu\n%s" \
136 "Percentage keys/data/padding/free/rechdrs/freehdrs/hashes: %.0f/%.0f/%.0f/%.0f/%.0f/%.0f/%.0f\n"
138 #define BUCKET_SUMMARY_FORMAT_A \
139 "Free bucket %zu: total entries %zu.\n" \
140 "Smallest/average/largest length: %zu/%zu/%zu\n%s"
141 #define BUCKET_SUMMARY_FORMAT_B \
142 "Free bucket %zu-%zu: total entries %zu.\n" \
143 "Smallest/average/largest length: %zu/%zu/%zu\n%s"
145 #define HISTO_WIDTH 70
146 #define HISTO_HEIGHT 20
148 char *tdb_summary(struct tdb_context *tdb, enum tdb_summary_flags flags)
151 struct tally *ftables, *hashes, *freet, *keys, *data, *extra, *uncoal,
153 char *hashesg, *freeg, *keysg, *datag, *extrag, *uncoalg, *bucketsg;
156 hashesg = freeg = keysg = datag = extrag = uncoalg = bucketsg = NULL;
158 if (tdb_allrecord_lock(tdb, F_RDLCK, TDB_LOCK_WAIT, false) != 0)
161 if (tdb_lock_expand(tdb, F_RDLCK) != 0) {
162 tdb_allrecord_unlock(tdb, F_RDLCK);
166 /* Start stats off empty. */
167 ftables = tally_new(HISTO_HEIGHT);
168 hashes = tally_new(HISTO_HEIGHT);
169 freet = tally_new(HISTO_HEIGHT);
170 keys = tally_new(HISTO_HEIGHT);
171 data = tally_new(HISTO_HEIGHT);
172 extra = tally_new(HISTO_HEIGHT);
173 uncoal = tally_new(HISTO_HEIGHT);
174 buckets = tally_new(HISTO_HEIGHT);
175 chains = tally_new(HISTO_HEIGHT);
176 if (!ftables || !hashes || !freet || !keys || !data || !extra
177 || !uncoal || !buckets || !chains) {
178 tdb_logerr(tdb, TDB_ERR_OOM, TDB_DEBUG_ERROR,
179 "tdb_summary: failed to allocate tally structures");
183 if (!summarize(tdb, hashes, ftables, freet, keys, data, extra, uncoal,
187 if (flags & TDB_SUMMARY_HISTOGRAMS) {
188 hashesg = tally_histogram(hashes, HISTO_WIDTH, HISTO_HEIGHT);
189 freeg = tally_histogram(freet, HISTO_WIDTH, HISTO_HEIGHT);
190 keysg = tally_histogram(keys, HISTO_WIDTH, HISTO_HEIGHT);
191 datag = tally_histogram(data, HISTO_WIDTH, HISTO_HEIGHT);
192 extrag = tally_histogram(extra, HISTO_WIDTH, HISTO_HEIGHT);
193 uncoalg = tally_histogram(uncoal, HISTO_WIDTH, HISTO_HEIGHT);
194 bucketsg = tally_histogram(buckets, HISTO_WIDTH, HISTO_HEIGHT);
197 /* 20 is max length of a %llu. */
198 len = strlen(SUMMARY_FORMAT) + 33*20 + 1
199 + (hashesg ? strlen(hashesg) : 0)
200 + (freeg ? strlen(freeg) : 0)
201 + (keysg ? strlen(keysg) : 0)
202 + (datag ? strlen(datag) : 0)
203 + (extrag ? strlen(extrag) : 0)
204 + (uncoalg ? strlen(uncoalg) : 0)
205 + (bucketsg ? strlen(bucketsg) : 0);
211 len = sprintf(ret, SUMMARY_FORMAT,
212 (size_t)tdb->map_size,
213 tally_num(keys) + tally_num(data),
215 tally_min(keys), tally_mean(keys), tally_max(keys),
217 tally_min(data), tally_mean(data), tally_max(data),
219 tally_min(extra), tally_mean(extra), tally_max(extra),
220 extrag ? extrag : "",
222 tally_min(freet), tally_mean(freet), tally_max(freet),
224 tally_total(uncoal, NULL),
225 tally_min(uncoal), tally_mean(uncoal), tally_max(uncoal),
226 uncoalg ? uncoalg : "",
228 bucketsg ? bucketsg : "",
229 count_hash(tdb, offsetof(struct tdb_header, hashtable),
230 TDB_TOPLEVEL_HASH_BITS),
231 1 << TDB_TOPLEVEL_HASH_BITS,
234 tally_min(hashes), tally_mean(hashes), tally_max(hashes),
235 hashesg ? hashesg : "",
236 tally_total(keys, NULL) * 100.0 / tdb->map_size,
237 tally_total(data, NULL) * 100.0 / tdb->map_size,
238 tally_total(extra, NULL) * 100.0 / tdb->map_size,
239 tally_total(freet, NULL) * 100.0 / tdb->map_size,
240 (tally_num(keys) + tally_num(freet) + tally_num(hashes))
241 * sizeof(struct tdb_used_record) * 100.0 / tdb->map_size,
242 tally_num(ftables) * sizeof(struct tdb_freetable)
243 * 100.0 / tdb->map_size,
245 * (sizeof(tdb_off_t) << TDB_SUBLEVEL_HASH_BITS)
246 + (sizeof(tdb_off_t) << TDB_TOPLEVEL_HASH_BITS)
247 + sizeof(struct tdb_chain) * tally_num(chains))
248 * 100.0 / tdb->map_size);
268 tdb_allrecord_unlock(tdb, F_RDLCK);
269 tdb_unlock_expand(tdb, F_RDLCK);