VNFs/DPPD-PROX/handle_lat.h

   1 /*
   2 // Copyright (c) 2010-2017 Intel Corporation
   3 //
   4 // Licensed under the Apache License, Version 2.0 (the "License");
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //     http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 */
  16
  17 #ifndef _HANDLE_LAT_H_
  18 #define _HANDLE_LAT_H_
  19
  20 #include <stdio.h>
  21 #include <math.h>
  22 #include <string.h>
  23
  24 #include "task_base.h"
  25 #include "clock.h"
  26
  27 #define LATENCY_ACCURACY        1
  28 // If ACCURACY_WINDOW is too small, the accuracy for packet N can be received by lat BEFORE
  29 // packet N is received (re-ordering) resulting in accuracy being unused
  30 // 8192 packets is equivalent to 550 micro-seconds at 10Gbps for 64 bytes packets
  31 #define ACCURACY_WINDOW         8192
  32
  33 struct lat_test {
  34         uint64_t tot_all_pkts;
  35         uint64_t tot_pkts;
  36         uint64_t max_lat;
  37         uint64_t min_lat;
  38         uint64_t tot_lat;
  39         unsigned __int128 var_lat; /* variance */
  40         uint64_t accuracy_limit_tsc;
  41
  42         uint64_t max_lat_error;
  43         uint64_t min_lat_error;
  44         uint64_t tot_lat_error;
  45         unsigned __int128 var_lat_error;
  46
  47         uint64_t buckets[128];
  48         uint64_t bucket_size;
  49         uint64_t lost_packets;
  50 };
  51
  52 static struct time_unit lat_test_get_accuracy_limit(struct lat_test *lat_test)
  53 {
  54         return tsc_to_time_unit(lat_test->accuracy_limit_tsc);
  55 }
  56
  57 static struct time_unit_err lat_test_get_avg(struct lat_test *lat_test)
  58 {
  59         uint64_t tsc;
  60         uint64_t tsc_error;
  61
  62         tsc = lat_test->tot_lat/lat_test->tot_pkts;
  63         tsc_error = lat_test->tot_lat_error/lat_test->tot_pkts;
  64
  65         struct time_unit_err ret = {
  66                 .time = tsc_to_time_unit(tsc),
  67                 .error = tsc_to_time_unit(tsc_error),
  68         };
  69
  70         return ret;
  71 }
  72
  73 static struct time_unit_err lat_test_get_min(struct lat_test *lat_test)
  74 {
  75         struct time_unit_err ret = {
  76                 .time = tsc_to_time_unit(lat_test->min_lat),
  77                 .error = tsc_to_time_unit(lat_test->min_lat_error),
  78         };
  79
  80         return ret;
  81 }
  82
  83 static struct time_unit_err lat_test_get_max(struct lat_test *lat_test)
  84 {
  85         struct time_unit_err ret = {
  86                 .time = tsc_to_time_unit(lat_test->max_lat),
  87                 .error = tsc_to_time_unit(lat_test->max_lat_error),
  88         };
  89
  90         return ret;
  91 }
  92
  93 static struct time_unit_err lat_test_get_stddev(struct lat_test *lat_test)
  94 {
  95         unsigned __int128 avg_tsc = lat_test->tot_lat/lat_test->tot_pkts;
  96         unsigned __int128 avg_tsc_squared = avg_tsc * avg_tsc;
  97         unsigned __int128 avg_squares_tsc = lat_test->var_lat/lat_test->tot_pkts;
  98
  99         /* The assumption is that variance fits into 64 bits, meaning
 100            that standard deviation fits into 32 bits. In other words,
 101            the assumption is that the standard deviation is not more
 102            than approximately 1 second. */
 103         uint64_t var_tsc = avg_squares_tsc - avg_tsc_squared;
 104         uint64_t stddev_tsc = sqrt(var_tsc);
 105
 106         unsigned __int128 avg_tsc_error = lat_test->tot_lat_error / lat_test->tot_pkts;
 107         unsigned __int128 avg_tsc_squared_error = 2 * avg_tsc * avg_tsc_error + avg_tsc_error * avg_tsc_error;
 108         unsigned __int128 avg_squares_tsc_error = lat_test->var_lat_error / lat_test->tot_pkts;
 109
 110         uint64_t var_tsc_error = avg_squares_tsc_error + avg_tsc_squared_error;
 111
 112         /* sqrt(a+-b) = sqrt(a) +- (-sqrt(a) + sqrt(a + b)) */
 113
 114         uint64_t stddev_tsc_error = - stddev_tsc + sqrt(var_tsc + var_tsc_error);
 115
 116         struct time_unit_err ret = {
 117                 .time = tsc_to_time_unit(stddev_tsc),
 118                 .error = tsc_to_time_unit(stddev_tsc_error),
 119         };
 120
 121         return ret;
 122 }
 123
 124 static void _lat_test_histogram_combine(struct lat_test *dst, struct lat_test *src)
 125 {
 126         for (size_t i = 0; i < sizeof(dst->buckets)/sizeof(dst->buckets[0]); ++i)
 127                 dst->buckets[i] += src->buckets[i];
 128 }
 129
 130 static void lat_test_combine(struct lat_test *dst, struct lat_test *src)
 131 {
 132         dst->tot_all_pkts += src->tot_all_pkts;
 133
 134         dst->tot_pkts += src->tot_pkts;
 135
 136         dst->tot_lat += src->tot_lat;
 137         dst->tot_lat_error += src->tot_lat_error;
 138
 139         /* (a +- b)^2 = a^2 +- (2ab + b^2) */
 140         dst->var_lat += src->var_lat;
 141         dst->var_lat_error += src->var_lat_error;
 142
 143         if (src->max_lat > dst->max_lat) {
 144                 dst->max_lat = src->max_lat;
 145                 dst->max_lat_error = src->max_lat_error;
 146         }
 147         if (src->min_lat < dst->min_lat) {
 148                 dst->min_lat = src->min_lat;
 149                 dst->min_lat_error = src->min_lat_error;
 150         }
 151
 152         if (src->accuracy_limit_tsc > dst->accuracy_limit_tsc)
 153                 dst->accuracy_limit_tsc = src->accuracy_limit_tsc;
 154         dst->lost_packets += src->lost_packets;
 155
 156 #ifdef LATENCY_HISTOGRAM
 157         _lat_test_histogram_combine(dst, src);
 158 #endif
 159 }
 160
 161 static void lat_test_reset(struct lat_test *lat_test)
 162 {
 163         lat_test->tot_all_pkts = 0;
 164         lat_test->tot_pkts = 0;
 165         lat_test->max_lat = 0;
 166         lat_test->min_lat = -1;
 167         lat_test->tot_lat = 0;
 168         lat_test->var_lat = 0;
 169         lat_test->max_lat_error = 0;
 170         lat_test->min_lat_error = 0;
 171         lat_test->tot_lat_error = 0;
 172         lat_test->var_lat_error = 0;
 173         lat_test->accuracy_limit_tsc = 0;
 174
 175         lat_test->lost_packets = 0;
 176
 177         memset(lat_test->buckets, 0, sizeof(lat_test->buckets));
 178 }
 179
 180 static void lat_test_copy(struct lat_test *dst, struct lat_test *src)
 181 {
 182         if (src->tot_all_pkts)
 183                 memcpy(dst, src, sizeof(struct lat_test));
 184 }
 185
 186 struct task_lat;
 187
 188 struct lat_test *task_lat_get_latency_meassurement(struct task_lat *task);
 189 void task_lat_use_other_latency_meassurement(struct task_lat *task);
 190 void task_lat_set_accuracy_limit(struct task_lat *task, uint32_t accuracy_limit_nsec);
 191
 192 #endif /* _HANDLE_LAT_H_ */