File: RequestDurationManager.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (97 lines) | stat: -rw-r--r-- 3,725 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2021 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

import Common
import Foundation
import TSCBasic

fileprivate extension Array where Element == Int {
  /// Creates a logarithmic histogram. For each `key`, the `value` contains the
  /// number of elements in this array that are smaller than `2 ^ key` but not
  /// smaller than `2 ^ (key - 1)`.
  var logHistogram: [Int: Int] {
    var result: [Int: Int] = [:]
    for value in self {
      let log: Int
      if value == 0 {
        // We put 0 in bucket 0 even though it should be in -inf. But that's
        // too hard to represent and we don't really care about 0 either.
        log = 0
      } else {
        log = Int(log2(Double(value))) + 1
      }
      result[log, default: 0] += 1
    }
    return result
  }
}

/// The time measurement of a single request. The request type and file are 
/// implicitly defined by the structure that this struct is contained in
struct Timing: Codable {
  /// The modification summary describing the state of the source file when the 
  /// request was made.
  var modification: String

  /// The offset in the file at which the request was made.
  var offset: Int

  /// The number of instructions sourcekitd took to exeucte the request.
  var instructions: Int

  /// Whether SourceKit reused an AST when serving the request. `nil` if it is
  /// unknown whether an AST was reused.
  var reusingASTContext: Bool?
}

/// Contains aggregated information for all request kinds of all files executed
/// by the stress tester.
fileprivate struct RequestDurations: Codable {
  // FIXME: We should be using `RequestKind` as the inner key but that causes
  // the inner dictionary to be serialized as an array (rdar://78099769)
  /// Maps file paths to request kinds to aggregated request duration information
  var files: [String: [String: [Timing]]]
}

/// Collects the durations that requests executed by the stress tester took and
/// writes them to `jsonFile` where the durations are collected together with
/// all other stress tester runs.
/// We are aggregating the results early (just keeping track of total
/// instructions executed for each request type and a logarithmic histogram
/// because keeping track of all request durations would result in a JSON file
/// that is too large to handle easily.
class RequestDurationManager {
  /// The file that stores the request durations and that gets updated as new
  /// aggregated information is added
  let jsonFile: URL

  init(jsonFile: URL) {
    self.jsonFile = jsonFile
  }

  private func getRequestDurations() throws -> RequestDurations {
    guard FileManager.default.fileExists(atPath: jsonFile.path) else {
      return RequestDurations(files: [:])
    }
    let data = try Data(contentsOf: jsonFile)
    return try JSONDecoder().decode(RequestDurations.self, from: data)
  }

  func add(timings: [Timing], for file: String, requestKind: RequestKind) throws {
    try localFileSystem.withLock(on: AbsolutePath(jsonFile.path), type: .exclusive) {
      var currentTimings = try getRequestDurations()
      currentTimings.files[file, default: [:]][requestKind.rawValue, default: []] += timings
      let data = try JSONEncoder().encode(currentTimings)
      try data.write(to: jsonFile)
    }
  }
}