2 * collectd - src/utils_latency.c
3 * Copyright (C) 2013 Florian Forster
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Florian Forster <ff at octo.it>
29 #include "utils_latency.h"
34 #ifndef HISTOGRAM_NUM_BINS
35 # define HISTOGRAM_NUM_BINS 1000
38 static const int HISTOGRAM_DEFAULT_BIN_WIDTH = 1;
40 struct latency_counter_s
51 int histogram[HISTOGRAM_NUM_BINS];
55 * Histogram represents the distribution of data, it has a list of "bins".
56 * Each bin represents an interval and has a count (frequency) of
57 * number of values fall within its interval.
59 * Histogram's range is determined by the number of bins and the bin width,
60 * There are 1000 bins and all bins have the same width of default 1 millisecond.
61 * When a value above this range is added, Histogram's range is increased by
62 * increasing the bin width (note that number of bins remains always at 1000).
63 * This operation of increasing bin width is little expensive as each bin need
64 * to be visited to update it's count. To reduce frequent change of bin width,
65 * new bin width will be the next nearest power of 2. Example: 2, 4, 8, 16, 32,
66 * 64, 128, 256, 512, 1024, 2048, 5086, ...
68 * So, if the required bin width is 300, then new bin width will be 512 as it is
69 * the next nearest power of 2.
72 void change_bin_width (latency_counter_t *lc, size_t val) /* {{{ */
75 /* This function is called because the new value is above histogram's range.
76 * First find the required bin width:
77 * requiredBinWidth = (value + 1) / numBins
78 * then get the next nearest power of 2
79 * newBinWidth = 2^(ceil(log2(requiredBinWidth)))
81 double required_bin_width = (double)(val + 1) / HISTOGRAM_NUM_BINS;
82 double required_bin_width_logbase2 = log(required_bin_width) / log(2.0);
83 int new_bin_width = (int)(pow(2.0, ceil( required_bin_width_logbase2)));
84 int old_bin_width = lc->bin_width;
85 lc->bin_width = new_bin_width;
88 * bin width has been increased, now iterate through all bins and move the
89 * old bin's count to new bin.
91 if (lc->num > 0) // if the histogram has data then iterate else skip
93 double width_change_ratio = old_bin_width / new_bin_width;
94 for (i=0; i<HISTOGRAM_NUM_BINS; i++)
96 int new_bin = (int)(i * width_change_ratio);
99 lc->histogram[new_bin] += lc->histogram[i];
100 lc->histogram[i] = 0;
102 DEBUG("utils_latency: change_bin_width: fixed all bins");
105 DEBUG("utils_latency: change_bin_width: val-[%zu], oldBinWidth-[%d], "
106 "newBinWidth-[%d], required_bin_width-[%f], "
107 "required_bin_width_logbase2-[%f]",
108 val, old_bin_width, new_bin_width, required_bin_width,
109 required_bin_width_logbase2);
111 } /* }}} void change_bin_width */
113 latency_counter_t *latency_counter_create () /* {{{ */
115 latency_counter_t *lc;
117 lc = malloc (sizeof (*lc));
120 memset (lc, 0, sizeof (*lc));
122 latency_counter_reset (lc);
123 lc->bin_width = HISTOGRAM_DEFAULT_BIN_WIDTH;
125 } /* }}} latency_counter_t *latency_counter_create */
127 void latency_counter_destroy (latency_counter_t *lc) /* {{{ */
130 } /* }}} void latency_counter_destroy */
132 void latency_counter_add (latency_counter_t *lc, cdtime_t latency) /* {{{ */
136 if ((lc == NULL) || (latency == 0))
142 if ((lc->min == 0) && (lc->max == 0))
143 lc->min = lc->max = latency;
144 if (lc->min > latency)
146 if (lc->max < latency)
149 /* A latency of _exactly_ 1.0 ms should be stored in the buffer 0, so
150 * subtract one from the cdtime_t value so that exactly 1.0 ms get sorted
152 latency_ms = (size_t) CDTIME_T_TO_MS (latency - 1);
154 int bin = (int)(latency_ms / lc->bin_width);
155 if (bin >= HISTOGRAM_NUM_BINS)
157 change_bin_width(lc, latency_ms);
158 bin = (int)(latency_ms / lc->bin_width);
159 if (bin >= HISTOGRAM_NUM_BINS)
161 ERROR("utils_latency: latency_counter_add: Invalid bin %d", bin);
165 lc->histogram[bin]++;
166 } /* }}} void latency_counter_add */
168 void latency_counter_reset (latency_counter_t *lc) /* {{{ */
173 int bin_width = lc->bin_width;
174 memset (lc, 0, sizeof (*lc));
176 /* preserve bin width */
177 lc->bin_width = bin_width;
178 lc->start_time = cdtime ();
179 } /* }}} void latency_counter_reset */
181 cdtime_t latency_counter_get_min (latency_counter_t *lc) /* {{{ */
186 } /* }}} cdtime_t latency_counter_get_min */
188 cdtime_t latency_counter_get_max (latency_counter_t *lc) /* {{{ */
193 } /* }}} cdtime_t latency_counter_get_max */
195 cdtime_t latency_counter_get_sum (latency_counter_t *lc) /* {{{ */
200 } /* }}} cdtime_t latency_counter_get_sum */
202 size_t latency_counter_get_num (latency_counter_t *lc) /* {{{ */
207 } /* }}} size_t latency_counter_get_num */
209 cdtime_t latency_counter_get_average (latency_counter_t *lc) /* {{{ */
213 if ((lc == NULL) || (lc->num == 0))
216 average = CDTIME_T_TO_DOUBLE (lc->sum) / ((double) lc->num);
217 return (DOUBLE_TO_CDTIME_T (average));
218 } /* }}} cdtime_t latency_counter_get_average */
220 cdtime_t latency_counter_get_percentile (latency_counter_t *lc,
223 double percent_upper;
224 double percent_lower;
227 double ms_interpolated;
231 if ((lc == NULL) || (lc->num == 0) || !((percent > 0.0) && (percent < 100.0)))
234 /* Find index i so that at least "percent" events are within i+1 ms. */
238 for (i = 0; i < HISTOGRAM_NUM_BINS; i++)
240 percent_lower = percent_upper;
241 sum += lc->histogram[i];
245 percent_upper = 100.0 * ((double) sum) / ((double) lc->num);
247 if (percent_upper >= percent)
251 if (i >= HISTOGRAM_NUM_BINS)
254 assert (percent_upper >= percent);
255 assert (percent_lower < percent);
257 ms_upper = (double) ( (i + 1) * lc->bin_width );
258 ms_lower = (double) ( i * lc->bin_width );
260 return (MS_TO_CDTIME_T (ms_upper));
262 ms_interpolated = (((percent_upper - percent) * ms_lower)
263 + ((percent - percent_lower) * ms_upper))
264 / (percent_upper - percent_lower);
266 return (MS_TO_CDTIME_T (ms_interpolated));
267 } /* }}} cdtime_t latency_counter_get_percentile */
269 /* vim: set sw=2 sts=2 et fdm=marker : */