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);
29 if (TDB_PTR_IS_ERR(h)) {
30 tdb->ecode = TDB_PTR_ERR(h);
33 for (i = 0; i < (1 << bits); i++)
36 tdb_access_release(tdb, h);
40 static bool summarize(struct tdb_context *tdb,
42 struct tally *ftables,
48 struct tally *buckets,
55 for (off = sizeof(struct tdb_header); off < tdb->map_size; off += len) {
57 struct tdb_used_record u;
58 struct tdb_free_record f;
59 struct tdb_recovery_record r;
61 /* We might not be able to get the whole thing. */
62 p = tdb_access_read(tdb, off, sizeof(p->f), true);
63 if (TDB_PTR_IS_ERR(p)) {
64 tdb->ecode = TDB_PTR_ERR(p);
67 if (p->r.magic == TDB_RECOVERY_INVALID_MAGIC
68 || p->r.magic == TDB_RECOVERY_MAGIC) {
70 tally_add(uncoal, unc);
73 len = sizeof(p->r) + p->r.max_len;
74 } else if (frec_magic(&p->f) == TDB_FREE_MAGIC) {
75 len = frec_len(&p->f);
77 tally_add(buckets, size_to_bucket(len));
80 } else if (rec_magic(&p->u) == TDB_USED_MAGIC) {
82 tally_add(uncoal, unc);
86 + rec_key_length(&p->u)
87 + rec_data_length(&p->u)
88 + rec_extra_padding(&p->u);
90 tally_add(keys, rec_key_length(&p->u));
91 tally_add(data, rec_data_length(&p->u));
92 tally_add(extra, rec_extra_padding(&p->u));
93 } else if (rec_magic(&p->u) == TDB_HTABLE_MAGIC) {
94 int count = count_hash(tdb,
96 TDB_SUBLEVEL_HASH_BITS);
99 tally_add(hashes, count);
100 tally_add(extra, rec_extra_padding(&p->u));
102 + rec_data_length(&p->u)
103 + rec_extra_padding(&p->u);
104 } else if (rec_magic(&p->u) == TDB_FTABLE_MAGIC) {
106 + rec_data_length(&p->u)
107 + rec_extra_padding(&p->u);
108 tally_add(ftables, rec_data_length(&p->u));
109 tally_add(extra, rec_extra_padding(&p->u));
110 } else if (rec_magic(&p->u) == TDB_CHAIN_MAGIC) {
112 + rec_data_length(&p->u)
113 + rec_extra_padding(&p->u);
114 tally_add(chains, 1);
115 tally_add(extra, rec_extra_padding(&p->u));
117 len = dead_space(tdb, off);
118 if (TDB_OFF_IS_ERR(len)) {
122 tdb_access_release(tdb, p);
125 tally_add(uncoal, unc);
129 #define SUMMARY_FORMAT \
130 "Size of file/data: %zu/%zu\n" \
131 "Number of records: %zu\n" \
132 "Smallest/average/largest keys: %zu/%zu/%zu\n%s" \
133 "Smallest/average/largest data: %zu/%zu/%zu\n%s" \
134 "Smallest/average/largest padding: %zu/%zu/%zu\n%s" \
135 "Number of free records: %zu\n" \
136 "Smallest/average/largest free records: %zu/%zu/%zu\n%s" \
137 "Number of uncoalesced records: %zu\n" \
138 "Smallest/average/largest uncoalesced runs: %zu/%zu/%zu\n%s" \
139 "Number of free lists: %zu\n%s" \
140 "Toplevel hash used: %u of %u\n" \
141 "Number of chains: %zu\n" \
142 "Number of subhashes: %zu\n" \
143 "Smallest/average/largest subhash entries: %zu/%zu/%zu\n%s" \
144 "Percentage keys/data/padding/free/rechdrs/freehdrs/hashes: %.0f/%.0f/%.0f/%.0f/%.0f/%.0f/%.0f\n"
146 #define BUCKET_SUMMARY_FORMAT_A \
147 "Free bucket %zu: total entries %zu.\n" \
148 "Smallest/average/largest length: %zu/%zu/%zu\n%s"
149 #define BUCKET_SUMMARY_FORMAT_B \
150 "Free bucket %zu-%zu: total entries %zu.\n" \
151 "Smallest/average/largest length: %zu/%zu/%zu\n%s"
153 #define HISTO_WIDTH 70
154 #define HISTO_HEIGHT 20
156 char *tdb_summary(struct tdb_context *tdb, enum tdb_summary_flags flags)
159 struct tally *ftables, *hashes, *freet, *keys, *data, *extra, *uncoal,
161 char *hashesg, *freeg, *keysg, *datag, *extrag, *uncoalg, *bucketsg;
163 enum TDB_ERROR ecode;
165 hashesg = freeg = keysg = datag = extrag = uncoalg = bucketsg = NULL;
167 ecode = tdb_allrecord_lock(tdb, F_RDLCK, TDB_LOCK_WAIT, false);
168 if (ecode != TDB_SUCCESS) {
173 ecode = tdb_lock_expand(tdb, F_RDLCK);
174 if (ecode != TDB_SUCCESS) {
176 tdb_allrecord_unlock(tdb, F_RDLCK);
180 /* Start stats off empty. */
181 ftables = tally_new(HISTO_HEIGHT);
182 hashes = tally_new(HISTO_HEIGHT);
183 freet = tally_new(HISTO_HEIGHT);
184 keys = tally_new(HISTO_HEIGHT);
185 data = tally_new(HISTO_HEIGHT);
186 extra = tally_new(HISTO_HEIGHT);
187 uncoal = tally_new(HISTO_HEIGHT);
188 buckets = tally_new(HISTO_HEIGHT);
189 chains = tally_new(HISTO_HEIGHT);
190 if (!ftables || !hashes || !freet || !keys || !data || !extra
191 || !uncoal || !buckets || !chains) {
192 tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
193 "tdb_summary: failed to allocate tally structures");
197 if (!summarize(tdb, hashes, ftables, freet, keys, data, extra, uncoal,
201 if (flags & TDB_SUMMARY_HISTOGRAMS) {
202 hashesg = tally_histogram(hashes, HISTO_WIDTH, HISTO_HEIGHT);
203 freeg = tally_histogram(freet, HISTO_WIDTH, HISTO_HEIGHT);
204 keysg = tally_histogram(keys, HISTO_WIDTH, HISTO_HEIGHT);
205 datag = tally_histogram(data, HISTO_WIDTH, HISTO_HEIGHT);
206 extrag = tally_histogram(extra, HISTO_WIDTH, HISTO_HEIGHT);
207 uncoalg = tally_histogram(uncoal, HISTO_WIDTH, HISTO_HEIGHT);
208 bucketsg = tally_histogram(buckets, HISTO_WIDTH, HISTO_HEIGHT);
211 /* 20 is max length of a %llu. */
212 len = strlen(SUMMARY_FORMAT) + 33*20 + 1
213 + (hashesg ? strlen(hashesg) : 0)
214 + (freeg ? strlen(freeg) : 0)
215 + (keysg ? strlen(keysg) : 0)
216 + (datag ? strlen(datag) : 0)
217 + (extrag ? strlen(extrag) : 0)
218 + (uncoalg ? strlen(uncoalg) : 0)
219 + (bucketsg ? strlen(bucketsg) : 0);
225 len = sprintf(ret, SUMMARY_FORMAT,
226 (size_t)tdb->map_size,
227 tally_num(keys) + tally_num(data),
229 tally_min(keys), tally_mean(keys), tally_max(keys),
231 tally_min(data), tally_mean(data), tally_max(data),
233 tally_min(extra), tally_mean(extra), tally_max(extra),
234 extrag ? extrag : "",
236 tally_min(freet), tally_mean(freet), tally_max(freet),
238 tally_total(uncoal, NULL),
239 tally_min(uncoal), tally_mean(uncoal), tally_max(uncoal),
240 uncoalg ? uncoalg : "",
242 bucketsg ? bucketsg : "",
243 count_hash(tdb, offsetof(struct tdb_header, hashtable),
244 TDB_TOPLEVEL_HASH_BITS),
245 1 << TDB_TOPLEVEL_HASH_BITS,
248 tally_min(hashes), tally_mean(hashes), tally_max(hashes),
249 hashesg ? hashesg : "",
250 tally_total(keys, NULL) * 100.0 / tdb->map_size,
251 tally_total(data, NULL) * 100.0 / tdb->map_size,
252 tally_total(extra, NULL) * 100.0 / tdb->map_size,
253 tally_total(freet, NULL) * 100.0 / tdb->map_size,
254 (tally_num(keys) + tally_num(freet) + tally_num(hashes))
255 * sizeof(struct tdb_used_record) * 100.0 / tdb->map_size,
256 tally_num(ftables) * sizeof(struct tdb_freetable)
257 * 100.0 / tdb->map_size,
259 * (sizeof(tdb_off_t) << TDB_SUBLEVEL_HASH_BITS)
260 + (sizeof(tdb_off_t) << TDB_TOPLEVEL_HASH_BITS)
261 + sizeof(struct tdb_chain) * tally_num(chains))
262 * 100.0 / tdb->map_size);
282 tdb_allrecord_unlock(tdb, F_RDLCK);
283 tdb_unlock_expand(tdb, F_RDLCK);