kconfig: use pkg-config for ncurses detection
[akaros.git] / user / benchutil / measure.c
1 /* Copyright (c) 2013 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Userspace functions for various measurements.
6  *
7  * For now, this is built into parlib.  We can pull it out in the future.  Many
8  * of the larger functions are in flux. */
9
10 #include <math.h>
11 #include <stdio.h>
12 #include <stdlib.h>
13 #include <sys/param.h>
14 #ifdef __ros__
15 #include <parlib/tsc-compat.h>
16 #include <benchutil/measure.h>
17 #endif /* __ros__ */
18
19 /* Basic stats computation and printing.
20  *
21  * All of these expect a 2D collection of samples, where the first array is an
22  * array of arrays of samples.  The first array's members are something like
23  * per-thread samples, where each thread fills in its
24  * data[thread_id][sample_number].  The samples should be ordered in
25  * chronological order.  Ultimately, the sample needs to produce a uint64_t
26  * (e.g. TSC tick). */
27
28 static void init_stats(struct sample_stats *stats)
29 {
30         stats->avg_time = 0;
31         stats->var_time = 0;
32         stats->max_time = 0;
33         stats->min_time = UINT64_MAX;
34         stats->lat_50 = 0;
35         stats->lat_75 = 0;
36         stats->lat_90 = 0;
37         stats->lat_99 = 0;
38         stats->total_samples = 0;
39 }
40
41 /* Could have options for printing for how many rows we want, how much we want
42  * to trim the max/min, and how many samples per bin. */
43 void compute_stats(void **data, int nr_i, int nr_j, struct sample_stats *stats)
44 {
45         uint64_t sample_time, hist_max_time, hist_min_time,
46                  lat_max_time, lat_min_time;
47         size_t hist_idx, lat_idx, hist_bin_sz, lat_bin_sz;
48         float accum_samples = 0.0, coef_var;
49         unsigned int *hist_times;
50         unsigned int *lat_times;
51         unsigned int nr_hist_bins = 75; /* looks reasonable when printed */
52         unsigned int nr_lat_bins = 500; /* affects granularity of lat perc */
53         unsigned int max_dots_per_row = 45; /* looks good with 80-wide col */
54         unsigned int max_hist_bin = 0;
55         #define HI_COEF_VAR 1.0
56
57         init_stats(stats);
58         /* First pass, figure out the min, max, avg, etc. */
59         for (int i = 0; i < nr_i; i++) {
60                 for (int j = 0; j < nr_j; j++) {
61                         /* get_sample returns 0 on success.  o/w, skip the
62                          * sample */
63                         /* depending on semantics, we could break */
64                         if (stats->get_sample(data, i, j, &sample_time))
65                                 continue;
66                         stats->total_samples++;
67                         stats->avg_time += sample_time;
68                         stats->max_time = sample_time > stats->max_time ?
69                                 sample_time : stats->max_time;
70                         stats->min_time = sample_time < stats->min_time ?
71                                 sample_time : stats->min_time;
72                 }
73         }
74         if (stats->total_samples < 2) {
75                 printf("Not enough samples (%llu) for avg and var\n",
76                        stats->total_samples);
77                 return;
78         }
79         stats->avg_time /= stats->total_samples;
80         /* Second pass, compute the variance.  Want to do this before the
81          * histograms, so we can trim the serious outliers */
82         for (int i = 0; i < nr_i; i++) {
83                 for (int j = 0; j < nr_j; j++) {
84                         if (stats->get_sample(data, i, j, &sample_time))
85                                 continue;
86                         /* var: (sum_i=1..n { (x_i - xbar)^2 }) / (n - 1) */
87                         stats->var_time += (sample_time - stats->avg_time) *
88                                            (sample_time - stats->avg_time);
89                 }
90         }
91         stats->var_time /= stats->total_samples - 1;
92         /* We have two histogram structures.  The main one is for printing, and
93          * the other is for computing latency percentiles.  The only real diff
94          * btw the two is the number of bins.  The latency one has a lot more,
95          * for finer granularity, and the regular one has fewer for better
96          * printing.
97          *
98          * Both have the same max and min bin values.  Any excesses get put in
99          * the smallest or biggest bin.  This keeps the granularity reasonable
100          * in the face of very large outliers.  Normally, I trim off anything
101          * outside 3 stddev.
102          * 
103          * High variation will throw off our histogram bins, so we adjust.  A
104          * coef_var > 1 is considered high variance.  The numbers I picked are
105          * just heuristics to catch SMM interference and make the output look
106          * nice. */
107         coef_var = sqrt(stats->var_time) / stats->avg_time;
108         if (coef_var > HI_COEF_VAR) {
109                 hist_max_time = stats->avg_time * 3;
110                 hist_min_time = stats->avg_time / 3;
111         } else {        /* 'normal' data */
112                 /* trimming the printable hist at 3 stddevs, which for normal
113                  * data is 99.7% of the data.  For most any data, it gets 89%
114                  * (Chebyshev's inequality) */
115                 hist_max_time = stats->avg_time + 3 * sqrt(stats->var_time);
116                 hist_min_time = stats->avg_time - 3 * sqrt(stats->var_time);
117                 if (hist_min_time > hist_max_time)
118                         hist_min_time = 0;
119         }
120         lat_max_time = hist_max_time;
121         lat_min_time = hist_min_time;
122         hist_bin_sz = (hist_max_time - hist_min_time) / nr_hist_bins + 1;
123         lat_bin_sz = (lat_max_time - lat_min_time) / nr_lat_bins + 1;
124         hist_times = malloc(sizeof(unsigned int) * nr_hist_bins);
125         lat_times = malloc(sizeof(unsigned int) * nr_lat_bins);
126         if (!hist_times || !lat_times) {
127                 perror("compute_stats failed to alloc hist/lat arrays:");
128                 free(hist_times);
129                 free(lat_times);
130                 return;
131         }
132         memset(hist_times, 0, sizeof(unsigned int) * nr_hist_bins);
133         memset(lat_times, 0, sizeof(unsigned int) * nr_lat_bins);
134         /* third pass, fill the bins for the histogram and latencies */
135         for (int i = 0; i < nr_i; i++) {
136                 for (int j = 0; j < nr_j; j++) {
137                         if (stats->get_sample(data, i, j, &sample_time))
138                                 continue;
139                         /* need to shift, offset by min_time.  anything too
140                          * small is 0 and will go into the first bin.  anything
141                          * too large will go into the last bin. */
142                         lat_idx = sample_time < lat_min_time
143                                   ? 0
144                                   : (sample_time - lat_min_time) / lat_bin_sz;
145                         lat_idx = MIN(lat_idx, nr_lat_bins - 1);
146                         lat_times[lat_idx]++;
147                         hist_idx = sample_time < hist_min_time
148                                    ? 0
149                                    : (sample_time - hist_min_time) /
150                                      hist_bin_sz;
151                         hist_idx = MIN(hist_idx, nr_hist_bins - 1);
152                         hist_times[hist_idx]++;
153                         /* useful for formatting the ***s */
154                         max_hist_bin = (hist_times[hist_idx] > max_hist_bin)
155                                        ? hist_times[hist_idx]
156                                        : max_hist_bin;
157                 }
158         }
159         /* Compute latency percentiles */
160         for (int i = 0; i < nr_lat_bins; i++) {
161                 accum_samples += lat_times[i];
162                 /* (i + 1), since we've just accumulated one bucket's worth */
163                 if (!stats->lat_50 &&
164                     accum_samples / stats->total_samples > 0.50)
165                         stats->lat_50 = (i + 1) * lat_bin_sz + lat_min_time;
166                 if (!stats->lat_75 &&
167                     accum_samples / stats->total_samples > 0.75)
168                         stats->lat_75 = (i + 1) * lat_bin_sz + lat_min_time;
169                 if (!stats->lat_90 &&
170                     accum_samples / stats->total_samples > 0.90)
171                         stats->lat_90 = (i + 1) * lat_bin_sz + lat_min_time;
172                 if (!stats->lat_99 &&
173                     accum_samples / stats->total_samples > 0.99)
174                         stats->lat_99 = (i + 1) * lat_bin_sz + lat_min_time;
175         }
176         for (int i = 0; i < nr_hist_bins; i++) {
177                 uint64_t interval_start = i * hist_bin_sz + hist_min_time;
178                 uint64_t interval_end = (i + 1) * hist_bin_sz + hist_min_time;
179
180                 /* customize the first and last entries */
181                 if (i == 0)
182                         interval_start = MIN(interval_start, stats->min_time);
183                 if (i == nr_hist_bins - 1) {
184                         interval_end = MAX(interval_end, stats->max_time);
185                         /* but not at the sake of formatting! (8 spaces) */
186                         interval_end = MIN(interval_end, 99999999);
187                 }
188                 printf("    [%8llu - %8llu] %7d: ", interval_start,
189                        interval_end, hist_times[i]);
190                 /* nr_dots = hist_times[i] * nr_dots_per_sample
191                  *         = hist_times[i] * (max_num_dots / max_hist_bin) */
192                 int nr_dots = hist_times[i] * max_dots_per_row / max_hist_bin;
193
194                 for (int j = 0; j < nr_dots; j++)
195                         printf("*");
196                 printf("\n");
197         }
198         printf("\n");
199         printf("Samples per dot: %d\n", max_hist_bin / max_dots_per_row);
200         printf("Total samples: %llu\n", stats->total_samples);
201         printf("Avg time   : %llu\n", stats->avg_time);
202         printf("Stdev time : %f\n", sqrt(stats->var_time));
203         printf("Coef Var   : %f\n", coef_var);
204         if (coef_var > HI_COEF_VAR)
205                 printf(
206                   "\tHigh coeff of var with serious outliers, adjusted bins\n");
207         /* numbers are overestimates by at most a lat bin */
208         printf("50/75/90/99: %d / %d / %d / %d (-<%ld)\n", stats->lat_50,
209                stats->lat_75, stats->lat_90, stats->lat_99, lat_bin_sz);
210         printf("Min / Max  : %llu / %llu\n", stats->min_time, stats->max_time);
211         printf("\n");
212         free(hist_times);
213         free(lat_times);
214 }
215
216 /* Prints the throughput of certain events over nr_steps of interval time.  Will
217  * print the overall throughput of the entire time (total events / steps),
218  * and print out each step up to nr_print_steps.
219  *
220  * Assumes a 2D data structure, where the events in each data[i][] (for a
221  * specific i) are in order.  The 'nr_i'es are typically threads or something
222  * similar.  nr_j would be how many samples per thread.  The func ptr should
223  * return the time of the data[i][j]'th event via *sample and return 0 on
224  * success, and any other value for 'no data'.  If start_time is 0, we'll start
225  * the clock right before the first event. */
226 void print_throughput(void **data, unsigned int nr_steps, uint64_t interval,
227                       unsigned int nr_print_steps, uint64_t start_time,
228                       int nr_i, int nr_j,
229                       int (*get_sample)(void **data, int i, int j,
230                                         uint64_t *sample))
231 {
232         uint64_t time_now, sample;
233         /* next_sample[] tracks each thread's next lock that was acquired */
234         unsigned int *next_sample;
235         unsigned int *step_events;
236         unsigned int most_step_events = 1;
237         unsigned int max_dots_per_row = 45; /* looks good with 80-wide col */
238         unsigned int total_events = 0;
239
240         if (!nr_steps)
241                 return;
242         nr_print_steps = MIN(nr_print_steps, nr_steps);
243         next_sample = malloc(sizeof(unsigned int) * nr_i);
244         step_events = malloc(sizeof(unsigned int) * nr_steps);
245         if (!next_sample || !step_events) {
246                 perror("print_throughput failed alloc:");
247                 free(next_sample);
248                 free(step_events);
249                 return;
250         }
251         memset(next_sample, 0, sizeof(unsigned int) * nr_i);
252         memset(step_events, 0, sizeof(unsigned int) * nr_steps);
253         if (start_time) {
254                 time_now = start_time;
255         } else {
256                 time_now = UINT64_MAX;
257                 /* Set the replay to start right before the first event */
258                 for (int i = 0; i < nr_i; i++) {
259                         if (get_sample(data, i, 0, &sample))
260                                 continue;
261                         time_now = MIN(time_now, sample);
262                 }
263                 if (time_now != 0)
264                         time_now--;
265         }
266         for (int k = 0; k < nr_steps; k++) {
267                 time_now += interval;
268                 /* for every 'thread', we'll figure out how many events
269                  * occurred, and advance next_sample to track the next one to
270                  * consider */
271                 for (int i = 0; i < nr_i; i++) {
272                         /* count nr locks that have happened, advance per thread
273                          * tracker */
274                         for ( ; next_sample[i] < nr_j; next_sample[i]++) {
275                                 /* skip this thread if it has no more data */
276                                 if (get_sample(data, i, next_sample[i],
277                                                &sample))
278                                         continue;
279                                 /* break when we found one that hasn't happened
280                                  * yet */
281                                 if (!(sample <= time_now))
282                                         break;
283                                 step_events[k]++;
284                         }
285                 }
286                 total_events += step_events[k];
287                 /* for dynamically scaling the *'s */
288                 most_step_events = MAX(most_step_events, step_events[k]);
289         }
290         if (nr_print_steps)
291                 printf("Events per dot: %d\n",
292                        most_step_events / max_dots_per_row);
293         for (int k = 0; k < nr_print_steps; k++) {
294                 /* Last step isn't accurate, will only be partially full */
295                 if (k == nr_steps - 1)
296                         break;
297                 printf("%6d: ", k);
298                 printf("%6d ", step_events[k]);
299                 /* nr_dots = step_events[k] * nr_dots_per_event
300                  *   = step_events[k] * (max_dots_per_row / most_step_events) */
301                 int nr_dots = step_events[k] * max_dots_per_row /
302                               most_step_events;
303                 for (int i = 0; i < nr_dots; i++)
304                         printf("*");
305                 printf("\n");
306         }
307         printf("Total events: %d, Avg events/step: %d\n", total_events,
308                total_events / nr_steps);
309         free(next_sample);
310         free(step_events);
311 }