tools/hist/fio-histo-log-pctiles.py

   1 #!/usr/bin/env python
   2
   3 # module to parse fio histogram log files, not using pandas
   4 # runs in python v2 or v3
   5 # to get help with the CLI: $ python fio-histo-log-pctiles.py -h
   6 # this can be run standalone as a script but is callable
   7 # assumes all threads run for same time duration
   8 # assumes all threads are doing the same thing for the entire run
   9
  10 # percentiles:
  11 #  0 - min latency
  12 #  50 - median
  13 #  100 - max latency
  14
  15 # TO-DO:
  16 #   separate read and write stats for randrw mixed workload
  17 #   report average latency if needed
  18 #   prove that it works (partially done with unit tests)
  19
  20 # to run unit tests, set UNITTEST environment variable to anything
  21 # if you do this, don't pass normal CLI parameters to it
  22 # otherwise it runs the CLI
  23
  24 import sys, os, math, copy, time
  25 from copy import deepcopy
  26 import argparse
  27
  28 unittest2_imported = True
  29 try:
  30     import unittest2
  31 except ImportError:
  32     unittest2_imported = False
  33
  34 msec_per_sec = 1000
  35 nsec_per_usec = 1000
  36 direction_read = 0
  37 direction_write = 1
  38
  39 class FioHistoLogExc(Exception):
  40     pass
  41
  42 # if there is an error, print message, and exit with error status
  43
  44 def myabort(msg):
  45     print('ERROR: ' + msg)
  46     sys.exit(1)
  47
  48 # convert histogram log file into a list of
  49 # (time_ms, direction, bsz, buckets) tuples where
  50 # - time_ms is the time in msec at which the log record was written
  51 # - direction is 0 (read) or 1 (write)
  52 # - bsz is block size (not used)
  53 # - buckets is a CSV list of counters that make up the histogram
  54 # caller decides if the expected number of counters are present
  55
  56
  57 def exception_suffix( record_num, pathname ):
  58     return 'in histogram record %d file %s' % (record_num+1, pathname)
  59
  60 # log file parser raises FioHistoLogExc exceptions
  61 # it returns histogram buckets in whatever unit fio uses
  62 # inputs:
  63 #  logfn: pathname to histogram log file
  64 #  buckets_per_interval - how many histogram buckets to expect
  65 #  log_hist_msec - if not None, expected time interval between histogram records
  66
  67 def parse_hist_file(logfn, buckets_per_interval, log_hist_msec):
  68     previous_ts_ms_read = -1
  69     previous_ts_ms_write = -1
  70
  71     with open(logfn, 'r') as f:
  72         records = [ l.strip() for l in f.readlines() ]
  73     intervals = []
  74     last_time_ms = -1
  75     last_direction = -1
  76     for k, r in enumerate(records):
  77         if r == '':
  78             continue
  79         tokens = r.split(',')
  80         try:
  81             int_tokens = [ int(t) for t in tokens ]
  82         except ValueError as e:
  83             raise FioHistoLogExc('non-integer value %s' % exception_suffix(k+1, logfn))
  84
  85         neg_ints = list(filter( lambda tk : tk < 0, int_tokens ))
  86         if len(neg_ints) > 0:
  87             raise FioHistoLogExc('negative integer value %s' % exception_suffix(k+1, logfn))
  88
  89         if len(int_tokens) < 3:
  90             raise FioHistoLogExc('too few numbers %s' % exception_suffix(k+1, logfn))
  91
  92         direction = int_tokens[1]
  93         if direction != direction_read and direction != direction_write:
  94             raise FioHistoLogExc('invalid I/O direction %s' % exception_suffix(k+1, logfn))
  95
  96         time_ms = int_tokens[0]
  97         if direction == direction_read:
  98             if time_ms < previous_ts_ms_read:
  99                 raise FioHistoLogExc('read timestamp in column 1 decreased %s' % exception_suffix(k+1, logfn))
 100             previous_ts_ms_read = time_ms
 101         elif direction == direction_write:
 102             if time_ms < previous_ts_ms_write:
 103                 raise FioHistoLogExc('write timestamp in column 1 decreased %s' % exception_suffix(k+1, logfn))
 104             previous_ts_ms_write = time_ms
 105
 106         bsz = int_tokens[2]
 107         if bsz > (1 << 24):
 108             raise FioHistoLogExc('block size too large %s' % exception_suffix(k+1, logfn))
 109
 110         buckets = int_tokens[3:]
 111         if len(buckets) != buckets_per_interval:
 112             raise FioHistoLogExc('%d buckets per interval but %d expected in %s' %
 113                     (len(buckets), buckets_per_interval, exception_suffix(k+1, logfn)))
 114
 115         # hack to filter out records with the same timestamp
 116         # we should not have to do this if fio logs histogram records correctly
 117
 118         if time_ms == last_time_ms and direction == last_direction:
 119             continue
 120         last_time_ms = time_ms
 121         last_direction = direction
 122
 123         intervals.append((time_ms, direction, bsz, buckets))
 124     if len(intervals) == 0:
 125         raise FioHistoLogExc('no records in %s' % logfn)
 126     (first_timestamp, _, _, _) = intervals[0]
 127     if first_timestamp < 1000000:
 128         start_time = 0    # assume log_unix_epoch = 0
 129     elif log_hist_msec != None:
 130         start_time = first_timestamp - log_hist_msec
 131     elif len(intervals) > 1:
 132         (second_timestamp, _, _, _) = intervals[1]
 133         start_time = first_timestamp - (second_timestamp - first_timestamp)
 134     else:
 135         raise FioHistoLogExc('no way to estimate test start time')
 136     (end_timestamp, _, _, _) = intervals[-1]
 137
 138     return (intervals, start_time, end_timestamp)
 139
 140
 141 # compute time range for each bucket index in histogram record
 142 # see comments in https://github.com/axboe/fio/blob/master/stat.h
 143 # for description of bucket groups and buckets
 144 # fio v3 bucket ranges are in nanosec (since response times are measured in nanosec)
 145 # but we convert fio v3 nanosecs to floating-point microseconds
 146
 147 def time_ranges(groups, counters_per_group, fio_version=3):
 148     bucket_width = 1
 149     bucket_base = 0
 150     bucket_intervals = []
 151     for g in range(0, groups):
 152         for b in range(0, counters_per_group):
 153             rmin = float(bucket_base)
 154             rmax = rmin + bucket_width
 155             if fio_version == 3:
 156                 rmin /= nsec_per_usec
 157                 rmax /= nsec_per_usec
 158             bucket_intervals.append( [rmin, rmax] )
 159             bucket_base += bucket_width
 160         if g != 0:
 161             bucket_width *= 2
 162     return bucket_intervals
 163
 164
 165 # compute number of time quantum intervals in the test
 166
 167 def get_time_intervals(time_quantum, min_timestamp_ms, max_timestamp_ms):
 168     # round down to nearest second
 169     max_timestamp = max_timestamp_ms // msec_per_sec
 170     min_timestamp = min_timestamp_ms // msec_per_sec
 171     # round up to nearest whole multiple of time_quantum
 172     time_interval_count = ((max_timestamp - min_timestamp) + time_quantum) // time_quantum
 173     end_time = min_timestamp + (time_interval_count * time_quantum)
 174     return (end_time, time_interval_count)
 175
 176 # align raw histogram log data to time quantum so
 177 # we can then combine histograms from different threads with addition
 178 # for randrw workload we count both reads and writes in same output bucket
 179 # but we separate reads and writes for purposes of calculating
 180 # end time for histogram record.
 181 # this requires us to weight a raw histogram bucket by the
 182 # fraction of time quantum that the bucket overlaps the current
 183 # time quantum interval
 184 # for example, if we have a bucket with 515 samples for time interval
 185 # [ 1010, 2014 ] msec since start of test, and time quantum is 1 sec, then
 186 # for time quantum interval [ 1000, 2000 ] msec, the overlap is
 187 # (2000 - 1010) / (2000 - 1000) = 0.99
 188 # so the contribution of this bucket to this time quantum is
 189 # 515 x 0.99 = 509.85
 190
 191 def align_histo_log(raw_histogram_log, time_quantum, bucket_count, min_timestamp_ms, max_timestamp_ms):
 192
 193     # slice up test time int intervals of time_quantum seconds
 194
 195     (end_time, time_interval_count) = get_time_intervals(time_quantum, min_timestamp_ms, max_timestamp_ms)
 196     time_qtm_ms = time_quantum * msec_per_sec
 197     end_time_ms = end_time * msec_per_sec
 198     aligned_intervals = []
 199     for j in range(0, time_interval_count):
 200         aligned_intervals.append((
 201             min_timestamp_ms + (j * time_qtm_ms),
 202             [ 0.0 for j in range(0, bucket_count) ] ))
 203
 204     log_record_count = len(raw_histogram_log)
 205     for k, record in enumerate(raw_histogram_log):
 206
 207         # find next record with same direction to get end-time
 208         # have to avoid going past end of array
 209         # for fio randrw workload,
 210         # we have read and write records on same time interval
 211         # sometimes read and write records are in opposite order
 212         # assertion checks that next read/write record
 213         # can be separated by at most 2 other records
 214
 215         (time_msec, direction, sz, interval_buckets) = record
 216         if k+1 < log_record_count:
 217             (time_msec_end, direction2, _, _) = raw_histogram_log[k+1]
 218             if direction2 != direction:
 219                 if k+2 < log_record_count:
 220                     (time_msec_end, direction2, _, _) = raw_histogram_log[k+2]
 221                     if direction2 != direction:
 222                         if k+3 < log_record_count:
 223                             (time_msec_end, direction2, _, _) = raw_histogram_log[k+3]
 224                             assert direction2 == direction
 225                         else:
 226                             time_msec_end = end_time_ms
 227                 else:
 228                     time_msec_end = end_time_ms
 229         else:
 230             time_msec_end = end_time_ms
 231
 232         # calculate first quantum that overlaps this histogram record
 233
 234         offset_from_min_ts = time_msec - min_timestamp_ms
 235         qtm_start_ms = min_timestamp_ms + (offset_from_min_ts // time_qtm_ms) * time_qtm_ms
 236         qtm_end_ms = min_timestamp_ms + ((offset_from_min_ts + time_qtm_ms) // time_qtm_ms) * time_qtm_ms
 237         qtm_index = offset_from_min_ts // time_qtm_ms
 238
 239         # for each quantum that overlaps this histogram record's time interval
 240
 241         while qtm_start_ms < time_msec_end:  # while quantum overlaps record
 242
 243             # some histogram logs may be longer than others
 244
 245             if len(aligned_intervals) <= qtm_index:
 246                 break
 247
 248             # calculate fraction of time that this quantum
 249             # overlaps histogram record's time interval
 250
 251             overlap_start = max(qtm_start_ms, time_msec)
 252             overlap_end = min(qtm_end_ms, time_msec_end)
 253             weight = float(overlap_end - overlap_start)
 254             weight /= (time_msec_end - time_msec)
 255             (_,aligned_histogram) = aligned_intervals[qtm_index]
 256             for bx, b in enumerate(interval_buckets):
 257                 weighted_bucket = weight * b
 258                 aligned_histogram[bx] += weighted_bucket
 259
 260             # advance to the next time quantum
 261
 262             qtm_start_ms += time_qtm_ms
 263             qtm_end_ms += time_qtm_ms
 264             qtm_index += 1
 265
 266     return aligned_intervals
 267
 268 # add histogram in "source" to histogram in "target"
 269 # it is assumed that the 2 histograms are precisely time-aligned
 270
 271 def add_to_histo_from( target, source ):
 272     for b in range(0, len(source)):
 273         target[b] += source[b]
 274
 275 # compute percentiles
 276 # inputs:
 277 #   buckets: histogram bucket array
 278 #   wanted: list of floating-pt percentiles to calculate
 279 #   time_ranges: [tmin,tmax) time interval for each bucket
 280 # returns None if no I/O reported.
 281 # otherwise we would be dividing by zero
 282 # think of buckets as probability distribution function
 283 # and this loop is integrating to get cumulative distribution function
 284
 285 def get_pctiles(buckets, wanted, time_ranges):
 286
 287     # get total of IO requests done
 288     total_ios = 0
 289     for io_count in buckets:
 290         total_ios += io_count
 291
 292     # don't return percentiles if no I/O was done during interval
 293     if total_ios == 0.0:
 294         return None
 295
 296     pctile_count = len(wanted)
 297
 298     # results returned as dictionary keyed by percentile
 299     pctile_result = {}
 300
 301     # index of next percentile in list
 302     pctile_index = 0
 303
 304     # next percentile
 305     next_pctile = wanted[pctile_index]
 306
 307     # no one is interested in percentiles bigger than this but not 100.0
 308     # this prevents floating-point error from preventing loop exit
 309     almost_100 = 99.9999
 310
 311     # pct is the percentile corresponding to
 312     # all I/O requests up through bucket b
 313     pct = 0.0
 314     total_so_far = 0
 315     for b, io_count in enumerate(buckets):
 316         if io_count == 0:
 317             continue
 318         total_so_far += io_count
 319         # last_pct_lt is the percentile corresponding to
 320         # all I/O requests up to, but not including, bucket b
 321         last_pct = pct
 322         pct = 100.0 * float(total_so_far) / total_ios
 323         # a single bucket could satisfy multiple pctiles
 324         # so this must be a while loop
 325         # for 100-percentile (max latency) case, no bucket exceeds it
 326         # so we must stop there.
 327         while ((next_pctile == 100.0 and pct >= almost_100) or
 328                (next_pctile < 100.0  and pct > next_pctile)):
 329             # interpolate between min and max time for bucket time interval
 330             # we keep the time_ranges access inside this loop,
 331             # even though it could be above the loop,
 332             # because in many cases we will not be even entering
 333             # the loop so we optimize out these accesses
 334             range_max_time = time_ranges[b][1]
 335             range_min_time = time_ranges[b][0]
 336             offset_frac = (next_pctile - last_pct)/(pct - last_pct)
 337             interpolation = range_min_time + (offset_frac*(range_max_time - range_min_time))
 338             pctile_result[next_pctile] = interpolation
 339             pctile_index += 1
 340             if pctile_index == pctile_count:
 341                 break
 342             next_pctile = wanted[pctile_index]
 343         if pctile_index == pctile_count:
 344             break
 345     assert pctile_index == pctile_count
 346     return pctile_result
 347
 348
 349 # this is really the main program
 350
 351 def compute_percentiles_from_logs():
 352     parser = argparse.ArgumentParser()
 353     parser.add_argument("--fio-version", dest="fio_version",
 354         default="3", choices=[2,3], type=int,
 355         help="fio version (default=3)")
 356     parser.add_argument("--bucket-groups", dest="bucket_groups", default="29", type=int,
 357         help="fio histogram bucket groups (default=29)")
 358     parser.add_argument("--bucket-bits", dest="bucket_bits",
 359         default="6", type=int,
 360         help="fio histogram buckets-per-group bits (default=6 means 64 buckets/group)")
 361     parser.add_argument("--percentiles", dest="pctiles_wanted",
 362         default=[ 0., 50., 95., 99., 100.], type=float, nargs='+',
 363         help="fio histogram buckets-per-group bits (default=6 means 64 buckets/group)")
 364     parser.add_argument("--time-quantum", dest="time_quantum",
 365         default="1", type=int,
 366         help="time quantum in seconds (default=1)")
 367     parser.add_argument("--log-hist-msec", dest="log_hist_msec",
 368         type=int, default=None,
 369         help="log_hist_msec value in fio job file")
 370     parser.add_argument("--output-unit", dest="output_unit",
 371         default="usec", type=str,
 372         help="Latency percentile output unit: msec|usec|nsec (default usec)")
 373     parser.add_argument("file_list", nargs='+',
 374         help='list of files, preceded by " -- " if necessary')
 375     args = parser.parse_args()
 376
 377     # default changes based on fio version
 378     if args.fio_version == 2:
 379         args.bucket_groups = 19
 380
 381     # print parameters
 382
 383     print('fio version = %d' % args.fio_version)
 384     print('bucket groups = %d' % args.bucket_groups)
 385     print('bucket bits = %d' % args.bucket_bits)
 386     print('time quantum = %d sec' % args.time_quantum)
 387     print('percentiles = %s' % ','.join([ str(p) for p in args.pctiles_wanted ]))
 388     buckets_per_group = 1 << args.bucket_bits
 389     print('buckets per group = %d' % buckets_per_group)
 390     buckets_per_interval = buckets_per_group * args.bucket_groups
 391     print('buckets per interval = %d ' % buckets_per_interval)
 392     bucket_index_range = range(0, buckets_per_interval)
 393     if args.log_hist_msec != None:
 394         print('log_hist_msec = %d' % args.log_hist_msec)
 395     if args.time_quantum == 0:
 396         print('ERROR: time-quantum must be a positive number of seconds')
 397     print('output unit = ' + args.output_unit)
 398     if args.output_unit == 'msec':
 399         time_divisor = float(msec_per_sec)
 400     elif args.output_unit == 'usec':
 401         time_divisor = 1.0
 402
 403     # construct template for each histogram bucket array with buckets all zeroes
 404     # we just copy this for each new histogram
 405
 406     zeroed_buckets = [ 0.0 for r in bucket_index_range ]
 407
 408     # calculate response time interval associated with each histogram bucket
 409
 410     bucket_times = time_ranges(args.bucket_groups, buckets_per_group, fio_version=args.fio_version)
 411
 412     # parse the histogram logs
 413     # assumption: each bucket has a monotonically increasing time
 414     # assumption: time ranges do not overlap for a single thread's records
 415     # (exception: if randrw workload, then there is a read and a write
 416     # record for the same time interval)
 417
 418     test_start_time = 0
 419     test_end_time = 1.0e18
 420     hist_files = {}
 421     for fn in args.file_list:
 422         try:
 423             (hist_files[fn], log_start_time, log_end_time)  = parse_hist_file(fn, buckets_per_interval, args.log_hist_msec)
 424         except FioHistoLogExc as e:
 425             myabort(str(e))
 426         # we consider the test started when all threads have started logging
 427         test_start_time = max(test_start_time, log_start_time)
 428         # we consider the test over when one of the logs has ended
 429         test_end_time = min(test_end_time, log_end_time)
 430
 431     if test_start_time >= test_end_time:
 432         raise FioHistoLogExc('no time interval when all threads logs overlapped')
 433     if test_start_time > 0:
 434         print('all threads running as of unix epoch time %d = %s' % (
 435                test_start_time/float(msec_per_sec),
 436                time.ctime(test_start_time/1000.0)))
 437
 438     (end_time, time_interval_count) = get_time_intervals(args.time_quantum, test_start_time, test_end_time)
 439     all_threads_histograms = [ ((j*args.time_quantum*msec_per_sec), deepcopy(zeroed_buckets))
 440                                for j in range(0, time_interval_count) ]
 441
 442     for logfn in hist_files.keys():
 443         aligned_per_thread = align_histo_log(hist_files[logfn],
 444                                              args.time_quantum,
 445                                              buckets_per_interval,
 446                                              test_start_time,
 447                                              test_end_time)
 448         for t in range(0, time_interval_count):
 449             (_, all_threads_histo_t) = all_threads_histograms[t]
 450             (_, log_histo_t) = aligned_per_thread[t]
 451             add_to_histo_from( all_threads_histo_t, log_histo_t )
 452
 453     # calculate percentiles across aggregate histogram for all threads
 454     # print CSV header just like fiologparser_hist does
 455
 456     header = 'msec-since-start, '
 457     for p in args.pctiles_wanted:
 458         header += '%3.1f, ' % p
 459     print('time (millisec), percentiles in increasing order with values in ' + args.output_unit)
 460     print(header)
 461
 462     for (t_msec, all_threads_histo_t) in all_threads_histograms:
 463         record = '%8d, ' % t_msec
 464         pct = get_pctiles(all_threads_histo_t, args.pctiles_wanted, bucket_times)
 465         if not pct:
 466             for w in args.pctiles_wanted:
 467                 record += ', '
 468         else:
 469             pct_keys = [ k for k in pct.keys() ]
 470             pct_values = [ str(pct[wanted]/time_divisor) for wanted in sorted(pct_keys) ]
 471             record += ', '.join(pct_values)
 472         print(record)
 473
 474
 475
 476 #end of MAIN PROGRAM
 477
 478
 479 ##### below are unit tests ##############
 480
 481 if unittest2_imported:
 482   import tempfile, shutil
 483   from os.path import join
 484   should_not_get_here = False
 485
 486   class Test(unittest2.TestCase):
 487     tempdir = None
 488
 489     # a little less typing please
 490     def A(self, boolean_val):
 491         self.assertTrue(boolean_val)
 492
 493     # initialize unit test environment
 494
 495     @classmethod
 496     def setUpClass(cls):
 497         d = tempfile.mkdtemp()
 498         Test.tempdir = d
 499
 500     # remove anything left by unit test environment
 501     # unless user sets UNITTEST_LEAVE_FILES environment variable
 502
 503     @classmethod
 504     def tearDownClass(cls):
 505         if not os.getenv("UNITTEST_LEAVE_FILES"):
 506             shutil.rmtree(cls.tempdir)
 507
 508     def setUp(self):
 509         self.fn = join(Test.tempdir, self.id())
 510
 511     def test_a_add_histos(self):
 512         a = [ 1.0, 2.0 ]
 513         b = [ 1.5, 2.5 ]
 514         add_to_histo_from( a, b )
 515         self.A(a == [2.5, 4.5])
 516         self.A(b == [1.5, 2.5])
 517
 518     def test_b1_parse_log(self):
 519         with open(self.fn, 'w') as f:
 520             f.write('1234, 0, 4096, 1, 2, 3, 4\n')
 521             f.write('5678,1,16384,5,6,7,8 \n')
 522         (raw_histo_log, min_timestamp, max_timestamp) = parse_hist_file(self.fn, 4, None) # 4 buckets per interval
 523         # if not log_unix_epoch=1, then min_timestamp will always be set to zero
 524         self.A(len(raw_histo_log) == 2 and min_timestamp == 0 and max_timestamp == 5678)
 525         (time_ms, direction, bsz, histo) = raw_histo_log[0]
 526         self.A(time_ms == 1234 and direction == 0 and bsz == 4096 and histo == [ 1, 2, 3, 4 ])
 527         (time_ms, direction, bsz, histo) = raw_histo_log[1]
 528         self.A(time_ms == 5678 and direction == 1 and bsz == 16384 and histo == [ 5, 6, 7, 8 ])
 529
 530     def test_b2_parse_empty_log(self):
 531         with open(self.fn, 'w') as f:
 532             pass
 533         try:
 534             (raw_histo_log, _, _) = parse_hist_file(self.fn, 4, None)
 535             self.A(should_not_get_here)
 536         except FioHistoLogExc as e:
 537             self.A(str(e).startswith('no records'))
 538
 539     def test_b3_parse_empty_records(self):
 540         with open(self.fn, 'w') as f:
 541             f.write('\n')
 542             f.write('1234, 0, 4096, 1, 2, 3, 4\n')
 543             f.write('5678,1,16384,5,6,7,8 \n')
 544             f.write('\n')
 545         (raw_histo_log, _, max_timestamp_ms) = parse_hist_file(self.fn, 4, None)
 546         self.A(len(raw_histo_log) == 2 and max_timestamp_ms == 5678)
 547         (time_ms, direction, bsz, histo) = raw_histo_log[0]
 548         self.A(time_ms == 1234 and direction == 0 and bsz == 4096 and histo == [ 1, 2, 3, 4 ])
 549         (time_ms, direction, bsz, histo) = raw_histo_log[1]
 550         self.A(time_ms == 5678 and direction == 1 and bsz == 16384 and histo == [ 5, 6, 7, 8 ])
 551
 552     def test_b4_parse_non_int(self):
 553         with open(self.fn, 'w') as f:
 554             f.write('12, 0, 4096, 1a, 2, 3, 4\n')
 555         try:
 556             (raw_histo_log, _, _) = parse_hist_file(self.fn, 4, None)
 557             self.A(False)
 558         except FioHistoLogExc as e:
 559             self.A(str(e).startswith('non-integer'))
 560
 561     def test_b5_parse_neg_int(self):
 562         with open(self.fn, 'w') as f:
 563             f.write('-12, 0, 4096, 1, 2, 3, 4\n')
 564         try:
 565             (raw_histo_log, _, _) = parse_hist_file(self.fn, 4, None)
 566             self.A(False)
 567         except FioHistoLogExc as e:
 568             self.A(str(e).startswith('negative integer'))
 569
 570     def test_b6_parse_too_few_int(self):
 571         with open(self.fn, 'w') as f:
 572             f.write('0, 0\n')
 573         try:
 574             (raw_histo_log, _, _) = parse_hist_file(self.fn, 4, None)
 575             self.A(False)
 576         except FioHistoLogExc as e:
 577             self.A(str(e).startswith('too few numbers'))
 578
 579     def test_b7_parse_invalid_direction(self):
 580         with open(self.fn, 'w') as f:
 581             f.write('100, 2, 4096, 1, 2, 3, 4\n')
 582         try:
 583             (raw_histo_log, _, _) = parse_hist_file(self.fn, 4, None)
 584             self.A(False)
 585         except FioHistoLogExc as e:
 586             self.A(str(e).startswith('invalid I/O direction'))
 587
 588     def test_b8_parse_bsz_too_big(self):
 589         with open(self.fn+'_good', 'w') as f:
 590             f.write('100, 1, %d, 1, 2, 3, 4\n' % (1<<24))
 591         (raw_histo_log, _, _) = parse_hist_file(self.fn+'_good', 4, None)
 592         with open(self.fn+'_bad', 'w') as f:
 593             f.write('100, 1, 20000000, 1, 2, 3, 4\n')
 594         try:
 595             (raw_histo_log, _, _) = parse_hist_file(self.fn+'_bad', 4, None)
 596             self.A(False)
 597         except FioHistoLogExc as e:
 598             self.A(str(e).startswith('block size too large'))
 599
 600     def test_b9_parse_wrong_bucket_count(self):
 601         with open(self.fn, 'w') as f:
 602             f.write('100, 1, %d, 1, 2, 3, 4, 5\n' % (1<<24))
 603         try:
 604             (raw_histo_log, _, _) = parse_hist_file(self.fn, 4, None)
 605             self.A(False)
 606         except FioHistoLogExc as e:
 607             self.A(str(e).__contains__('buckets per interval'))
 608
 609     def test_c1_time_ranges(self):
 610         ranges = time_ranges(3, 2)  # fio_version defaults to 3
 611         expected_ranges = [ # fio_version 3 is in nanoseconds
 612                 [0.000, 0.001], [0.001, 0.002],   # first group
 613                 [0.002, 0.003], [0.003, 0.004],   # second group same width
 614                 [0.004, 0.006], [0.006, 0.008]]   # subsequent groups double width
 615         self.A(ranges == expected_ranges)
 616         ranges = time_ranges(3, 2, fio_version=3)
 617         self.A(ranges == expected_ranges)
 618         ranges = time_ranges(3, 2, fio_version=2)
 619         expected_ranges_v2 = [ [ 1000.0 * min_or_max for min_or_max in time_range ]
 620                                for time_range in expected_ranges ]
 621         self.A(ranges == expected_ranges_v2)
 622         # see fio V3 stat.h for why 29 groups and 2^6 buckets/group
 623         normal_ranges_v3 = time_ranges(29, 64)
 624         # for v3, bucket time intervals are measured in nanoseconds
 625         self.A(len(normal_ranges_v3) == 29 * 64 and normal_ranges_v3[-1][1] == 64*(1<<(29-1))/1000.0)
 626         normal_ranges_v2 = time_ranges(19, 64, fio_version=2)
 627         # for v2, bucket time intervals are measured in microseconds so we have fewer buckets
 628         self.A(len(normal_ranges_v2) == 19 * 64 and normal_ranges_v2[-1][1] == 64*(1<<(19-1)))
 629
 630     def test_d1_align_histo_log_1_quantum(self):
 631         with open(self.fn, 'w') as f:
 632             f.write('100, 1, 4096, 1, 2, 3, 4')
 633         (raw_histo_log, min_timestamp_ms, max_timestamp_ms) = parse_hist_file(self.fn, 4, None)
 634         self.A(min_timestamp_ms == 0 and max_timestamp_ms == 100)
 635         aligned_log = align_histo_log(raw_histo_log, 5, 4, min_timestamp_ms, max_timestamp_ms)
 636         self.A(len(aligned_log) == 1)
 637         (time_ms0, h) = aligned_log[0]
 638         self.A(time_ms0 == 0 and h == [1., 2., 3., 4.])
 639
 640     # handle case with log_unix_epoch=1 timestamps, 1-second time quantum
 641     # here both records will be separated into 2 aligned intervals
 642
 643     def test_d1a_align_2rec_histo_log_epoch_1_quantum_1sec(self):
 644         with open(self.fn, 'w') as f:
 645             f.write('1536504002123, 1, 4096, 1, 2, 3, 4\n')
 646             f.write('1536504003123, 1, 4096, 4, 3, 2, 1\n')
 647         (raw_histo_log, min_timestamp_ms, max_timestamp_ms) = parse_hist_file(self.fn, 4, None)
 648         self.A(min_timestamp_ms == 1536504001123 and max_timestamp_ms == 1536504003123)
 649         aligned_log = align_histo_log(raw_histo_log, 1, 4, min_timestamp_ms, max_timestamp_ms)
 650         self.A(len(aligned_log) == 3)
 651         (time_ms0, h) = aligned_log[0]
 652         self.A(time_ms0 == 1536504001123 and h == [0., 0., 0., 0.])
 653         (time_ms1, h) = aligned_log[1]
 654         self.A(time_ms1 == 1536504002123 and h == [1., 2., 3., 4.])
 655         (time_ms2, h) = aligned_log[2]
 656         self.A(time_ms2 == 1536504003123 and h == [4., 3., 2., 1.])
 657
 658     # handle case with log_unix_epoch=1 timestamps, 5-second time quantum
 659     # here both records will be merged into a single aligned time interval
 660
 661     def test_d1b_align_2rec_histo_log_epoch_1_quantum_5sec(self):
 662         with open(self.fn, 'w') as f:
 663             f.write('1536504002123, 1, 4096, 1, 2, 3, 4\n')
 664             f.write('1536504003123, 1, 4096, 4, 3, 2, 1\n')
 665         (raw_histo_log, min_timestamp_ms, max_timestamp_ms) = parse_hist_file(self.fn, 4, None)
 666         self.A(min_timestamp_ms == 1536504001123 and max_timestamp_ms == 1536504003123)
 667         aligned_log = align_histo_log(raw_histo_log, 5, 4, min_timestamp_ms, max_timestamp_ms)
 668         self.A(len(aligned_log) == 1)
 669         (time_ms0, h) = aligned_log[0]
 670         self.A(time_ms0 == 1536504001123 and h == [5., 5., 5., 5.])
 671
 672     # we need this to compare 2 lists of floating point numbers for equality
 673     # because of floating-point imprecision
 674
 675     def compare_2_floats(self, x, y):
 676         if x == 0.0 or y == 0.0:
 677             return (x+y) < 0.0000001
 678         else:
 679             return (math.fabs(x-y)/x) < 0.00001
 680
 681     def is_close(self, buckets, buckets_expected):
 682         if len(buckets) != len(buckets_expected):
 683             return False
 684         compare_buckets = lambda k: self.compare_2_floats(buckets[k], buckets_expected[k])
 685         indices_close = list(filter(compare_buckets, range(0, len(buckets))))
 686         return len(indices_close) == len(buckets)
 687
 688     def test_d2_align_histo_log_2_quantum(self):
 689         with open(self.fn, 'w') as f:
 690             f.write('2000, 1, 4096, 1, 2, 3, 4\n')
 691             f.write('7000, 1, 4096, 1, 2, 3, 4\n')
 692         (raw_histo_log, min_timestamp_ms, max_timestamp_ms) = parse_hist_file(self.fn, 4, None)
 693         self.A(min_timestamp_ms == 0 and max_timestamp_ms == 7000)
 694         (_, _, _, raw_buckets1) = raw_histo_log[0]
 695         (_, _, _, raw_buckets2) = raw_histo_log[1]
 696         aligned_log = align_histo_log(raw_histo_log, 5, 4, min_timestamp_ms, max_timestamp_ms)
 697         self.A(len(aligned_log) == 2)
 698         (time_ms1, h1) = aligned_log[0]
 699         (time_ms2, h2) = aligned_log[1]
 700         # because first record is from time interval [2000, 7000]
 701         # we weight it according
 702         expect1 = [float(b) * 0.6 for b in raw_buckets1]
 703         expect2 = [float(b) * 0.4 for b in raw_buckets1]
 704         for e in range(0, len(expect2)):
 705             expect2[e] += raw_buckets2[e]
 706         self.A(time_ms1 == 0    and self.is_close(h1, expect1))
 707         self.A(time_ms2 == 5000 and self.is_close(h2, expect2))
 708
 709     # what to expect if histogram buckets are all equal
 710     def test_e1_get_pctiles_flat_histo(self):
 711         with open(self.fn, 'w') as f:
 712             buckets = [ 100 for j in range(0, 128) ]
 713             f.write('9000, 1, 4096, %s\n' % ', '.join([str(b) for b in buckets]))
 714         (raw_histo_log, min_timestamp_ms, max_timestamp_ms) = parse_hist_file(self.fn, 128, None)
 715         self.A(min_timestamp_ms == 0 and max_timestamp_ms == 9000)
 716         aligned_log = align_histo_log(raw_histo_log, 5, 128, min_timestamp_ms, max_timestamp_ms)
 717         time_intervals = time_ranges(4, 32)
 718         # since buckets are all equal, then median is halfway through time_intervals
 719         # and max latency interval is at end of time_intervals
 720         self.A(time_intervals[64][1] == 0.066 and time_intervals[127][1] == 0.256)
 721         pctiles_wanted = [ 0, 50, 100 ]
 722         pct_vs_time = []
 723         for (time_ms, histo) in aligned_log:
 724             pct_vs_time.append(get_pctiles(histo, pctiles_wanted, time_intervals))
 725         self.A(pct_vs_time[0] == None)  # no I/O in this time interval
 726         expected_pctiles = { 0:0.000, 50:0.064, 100:0.256 }
 727         self.A(pct_vs_time[1] == expected_pctiles)
 728
 729     # what to expect if just the highest histogram bucket is used
 730     def test_e2_get_pctiles_highest_pct(self):
 731         fio_v3_bucket_count = 29 * 64
 732         with open(self.fn, 'w') as f:
 733             # make a empty fio v3 histogram
 734             buckets = [ 0 for j in range(0, fio_v3_bucket_count) ]
 735             # add one I/O request to last bucket
 736             buckets[-1] = 1
 737             f.write('9000, 1, 4096, %s\n' % ', '.join([str(b) for b in buckets]))
 738         (raw_histo_log, min_timestamp_ms, max_timestamp_ms) = parse_hist_file(self.fn, fio_v3_bucket_count, None)
 739         self.A(min_timestamp_ms == 0 and max_timestamp_ms == 9000)
 740         aligned_log = align_histo_log(raw_histo_log, 5, fio_v3_bucket_count, min_timestamp_ms, max_timestamp_ms)
 741         (time_ms, histo) = aligned_log[1]
 742         time_intervals = time_ranges(29, 64)
 743         expected_pctiles = { 100.0:(64*(1<<28))/1000.0 }
 744         pct = get_pctiles( histo, [ 100.0 ], time_intervals )
 745         self.A(pct == expected_pctiles)
 746
 747 # we are using this module as a standalone program
 748
 749 if __name__ == '__main__':
 750     if os.getenv('UNITTEST'):
 751         if unittest2_imported:
 752             sys.exit(unittest2.main())
 753         else:
 754             raise Exception('you must install unittest2 module to run unit test')
 755     else:
 756         compute_percentiles_from_logs()
 757