src/utils_latency.c

   1 /**
   2  * collectd - src/utils_latency.c
   3  * Copyright (C) 2013       Florian Forster
   4  *
   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:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  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.
  22  *
  23  * Authors:
  24  *   Florian Forster <ff at octo.it>
  25  **/
  26
  27 #include "collectd.h"
  28
  29 #include "plugin.h"
  30 #include "utils_latency.h"
  31 #include "common.h"
  32
  33 #include <math.h>
  34 #include <limits.h>
  35
  36 #ifndef LLONG_MAX
  37 # define LLONG_MAX 9223372036854775807LL
  38 #endif
  39
  40 #ifndef HISTOGRAM_NUM_BINS
  41 # define HISTOGRAM_NUM_BINS 1000
  42 #endif
  43
  44 #ifndef HISTOGRAM_DEFAULT_BIN_WIDTH
  45 /* 1048576 = 2^20 ^= 1/1024 s */
  46 # define HISTOGRAM_DEFAULT_BIN_WIDTH 1048576
  47 #endif
  48
  49 struct latency_counter_s
  50 {
  51   cdtime_t start_time;
  52
  53   cdtime_t sum;
  54   size_t num;
  55
  56   cdtime_t min;
  57   cdtime_t max;
  58
  59   cdtime_t bin_width;
  60   int histogram[HISTOGRAM_NUM_BINS];
  61 };
  62
  63 /*
  64 * Histogram represents the distribution of data, it has a list of "bins".
  65 * Each bin represents an interval and has a count (frequency) of
  66 * number of values fall within its interval.
  67 *
  68 * Histogram's range is determined by the number of bins and the bin width,
  69 * There are 1000 bins and all bins have the same width of default 1 millisecond.
  70 * When a value above this range is added, Histogram's range is increased by
  71 * increasing the bin width (note that number of bins remains always at 1000).
  72 * This operation of increasing bin width is little expensive as each bin need
  73 * to be visited to update it's count. To reduce frequent change of bin width,
  74 * new bin width will be the next nearest power of 2. Example: 2, 4, 8, 16, 32,
  75 * 64, 128, 256, 512, 1024, 2048, 5086, ...
  76 *
  77 * So, if the required bin width is 300, then new bin width will be 512 as it is
  78 * the next nearest power of 2.
  79 */
  80 static void change_bin_width (latency_counter_t *lc, cdtime_t latency) /* {{{ */
  81 {
  82   /* This function is called because the new value is above histogram's range.
  83    * First find the required bin width:
  84    *           requiredBinWidth = (value + 1) / numBins
  85    * then get the next nearest power of 2
  86    *           newBinWidth = 2^(ceil(log2(requiredBinWidth)))
  87    */
  88   double required_bin_width = ((double) (latency + 1)) / ((double) HISTOGRAM_NUM_BINS);
  89   double required_bin_width_logbase2 = log (required_bin_width) / log (2.0);
  90   cdtime_t new_bin_width = (cdtime_t) (pow (2.0, ceil (required_bin_width_logbase2)) + .5);
  91   cdtime_t old_bin_width = lc->bin_width;
  92
  93   lc->bin_width = new_bin_width;
  94
  95   /* bin_width has been increased, now iterate through all bins and move the
  96    * old bin's count to new bin. */
  97   if (lc->num > 0) // if the histogram has data then iterate else skip
  98   {
  99       double width_change_ratio = ((double) old_bin_width) / ((double) new_bin_width);
 100
 101       for (size_t i = 0; i < HISTOGRAM_NUM_BINS; i++)
 102       {
 103          size_t new_bin = (size_t) (((double) i) * width_change_ratio);
 104          if (i == new_bin)
 105              continue;
 106          assert (new_bin < i);
 107
 108          lc->histogram[new_bin] += lc->histogram[i];
 109          lc->histogram[i] = 0;
 110       }
 111   }
 112
 113   DEBUG("utils_latency: change_bin_width: latency = %.3f; "
 114       "old_bin_width = %.3f; new_bin_width = %.3f;",
 115       CDTIME_T_TO_DOUBLE (latency),
 116       CDTIME_T_TO_DOUBLE (old_bin_width),
 117       CDTIME_T_TO_DOUBLE (new_bin_width));
 118 } /* }}} void change_bin_width */
 119
 120 latency_counter_t *latency_counter_create (void) /* {{{ */
 121 {
 122   latency_counter_t *lc;
 123
 124   lc = calloc (1, sizeof (*lc));
 125   if (lc == NULL)
 126     return (NULL);
 127
 128   lc->bin_width = HISTOGRAM_DEFAULT_BIN_WIDTH;
 129   latency_counter_reset (lc);
 130   return (lc);
 131 } /* }}} latency_counter_t *latency_counter_create */
 132
 133 void latency_counter_destroy (latency_counter_t *lc) /* {{{ */
 134 {
 135   sfree (lc);
 136 } /* }}} void latency_counter_destroy */
 137
 138 void latency_counter_add (latency_counter_t *lc, cdtime_t latency) /* {{{ */
 139 {
 140   cdtime_t bin;
 141
 142   if ((lc == NULL) || (latency == 0) || (latency > ((cdtime_t) LLONG_MAX)))
 143     return;
 144
 145   lc->sum += latency;
 146   lc->num++;
 147
 148   if ((lc->min == 0) && (lc->max == 0))
 149     lc->min = lc->max = latency;
 150   if (lc->min > latency)
 151     lc->min = latency;
 152   if (lc->max < latency)
 153     lc->max = latency;
 154
 155   /* A latency of _exactly_ 1.0 ms should be stored in the buffer 0, so
 156    * subtract one from the cdtime_t value so that exactly 1.0 ms get sorted
 157    * accordingly. */
 158   bin = (latency - 1) / lc->bin_width;
 159   if (bin >= HISTOGRAM_NUM_BINS)
 160   {
 161       change_bin_width (lc, latency);
 162       bin = (latency - 1) / lc->bin_width;
 163       if (bin >= HISTOGRAM_NUM_BINS)
 164       {
 165           ERROR ("utils_latency: latency_counter_add: Invalid bin: %"PRIu64, bin);
 166           return;
 167       }
 168   }
 169   lc->histogram[bin]++;
 170 } /* }}} void latency_counter_add */
 171
 172 void latency_counter_reset (latency_counter_t *lc) /* {{{ */
 173 {
 174   if (lc == NULL)
 175     return;
 176
 177   cdtime_t bin_width = lc->bin_width;
 178   cdtime_t max_bin = (lc->max - 1) / lc->bin_width;
 179
 180 /*
 181   If max latency is REDUCE_THRESHOLD times less than histogram's range,
 182   then cut it in half. REDUCE_THRESHOLD must be >= 2.
 183   Value of 4 is selected to reduce frequent changes of bin width.
 184 */
 185 #define REDUCE_THRESHOLD 4
 186   if ((lc->num > 0) && (lc->bin_width >= HISTOGRAM_DEFAULT_BIN_WIDTH * 2)
 187      && (max_bin < HISTOGRAM_NUM_BINS / REDUCE_THRESHOLD))
 188   {
 189     /* new bin width will be the previous power of 2 */
 190     bin_width = bin_width / 2;
 191
 192     DEBUG("utils_latency: latency_counter_reset: max_latency = %.3f; "
 193           "max_bin = %"PRIu64"; old_bin_width = %.3f; new_bin_width = %.3f;",
 194         CDTIME_T_TO_DOUBLE (lc->max),
 195         max_bin,
 196         CDTIME_T_TO_DOUBLE (lc->bin_width),
 197         CDTIME_T_TO_DOUBLE (bin_width));
 198   }
 199
 200   memset (lc, 0, sizeof (*lc));
 201
 202   /* preserve bin width */
 203   lc->bin_width = bin_width;
 204   lc->start_time = cdtime ();
 205 } /* }}} void latency_counter_reset */
 206
 207 cdtime_t latency_counter_get_min (latency_counter_t *lc) /* {{{ */
 208 {
 209   if (lc == NULL)
 210     return (0);
 211   return (lc->min);
 212 } /* }}} cdtime_t latency_counter_get_min */
 213
 214 cdtime_t latency_counter_get_max (latency_counter_t *lc) /* {{{ */
 215 {
 216   if (lc == NULL)
 217     return (0);
 218   return (lc->max);
 219 } /* }}} cdtime_t latency_counter_get_max */
 220
 221 cdtime_t latency_counter_get_sum (latency_counter_t *lc) /* {{{ */
 222 {
 223   if (lc == NULL)
 224     return (0);
 225   return (lc->sum);
 226 } /* }}} cdtime_t latency_counter_get_sum */
 227
 228 size_t latency_counter_get_num (latency_counter_t *lc) /* {{{ */
 229 {
 230   if (lc == NULL)
 231     return (0);
 232   return (lc->num);
 233 } /* }}} size_t latency_counter_get_num */
 234
 235 cdtime_t latency_counter_get_average (latency_counter_t *lc) /* {{{ */
 236 {
 237   double average;
 238
 239   if ((lc == NULL) || (lc->num == 0))
 240     return (0);
 241
 242   average = CDTIME_T_TO_DOUBLE (lc->sum) / ((double) lc->num);
 243   return (DOUBLE_TO_CDTIME_T (average));
 244 } /* }}} cdtime_t latency_counter_get_average */
 245
 246 cdtime_t latency_counter_get_percentile (latency_counter_t *lc, /* {{{ */
 247     double percent)
 248 {
 249   double percent_upper;
 250   double percent_lower;
 251   double p;
 252   cdtime_t latency_lower;
 253   cdtime_t latency_interpolated;
 254   int sum;
 255   size_t i;
 256
 257   if ((lc == NULL) || (lc->num == 0) || !((percent > 0.0) && (percent < 100.0)))
 258     return (0);
 259
 260   /* Find index i so that at least "percent" events are within i+1 ms. */
 261   percent_upper = 0.0;
 262   percent_lower = 0.0;
 263   sum = 0;
 264   for (i = 0; i < HISTOGRAM_NUM_BINS; i++)
 265   {
 266     percent_lower = percent_upper;
 267     sum += lc->histogram[i];
 268     if (sum == 0)
 269       percent_upper = 0.0;
 270     else
 271       percent_upper = 100.0 * ((double) sum) / ((double) lc->num);
 272
 273     if (percent_upper >= percent)
 274       break;
 275   }
 276
 277   if (i >= HISTOGRAM_NUM_BINS)
 278     return (0);
 279
 280   assert (percent_upper >= percent);
 281   assert (percent_lower < percent);
 282
 283   if (i == 0)
 284     return (lc->bin_width);
 285
 286   latency_lower = ((cdtime_t) i) * lc->bin_width;
 287   p = (percent - percent_lower) / (percent_upper - percent_lower);
 288
 289   latency_interpolated = latency_lower
 290     + DOUBLE_TO_CDTIME_T (p * CDTIME_T_TO_DOUBLE (lc->bin_width));
 291
 292   DEBUG ("latency_counter_get_percentile: latency_interpolated = %.3f",
 293       CDTIME_T_TO_DOUBLE (latency_interpolated));
 294   return (latency_interpolated);
 295 } /* }}} cdtime_t latency_counter_get_percentile */
 296
 297 /* vim: set sw=2 sts=2 et fdm=marker : */